fortinet.fortimanager.fmgr_fmupdate_service 模块 – 启用/禁用内置 FortiGuard 提供的服务。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新功能

概要

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

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

参数

参数

注释

access_token

字符串

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

bypass_validation

布尔值

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

选项

  • false ←（默认）

  • true

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

fmupdate_service

字典

设置的顶级参数。

avips

字符串

启用/禁用内置 FortiGuard 以提供 FortiGuard 防病毒和 IPS 更新

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_antispam

别名: query-antispam

字符串

启用/禁用反垃圾邮件服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_antivirus

别名: query-antivirus

字符串

启用/禁用防病毒查询服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_filequery

别名: query-filequery

字符串

启用/禁用文件查询服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_geoip

别名: query-geoip

字符串

启用/禁用 geoip 服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_ioc

别名: query-ioc

字符串

启用/禁用内置 FortiGuard 以提供 IoC 查询

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_iot

别名: query-iot

字符串

启用/禁用文件查询服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_iot_collection

别名: query-iot-collection

字符串

启用/禁用 IoT 集合查询服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_iot_vulnerability

别名: query-iot-vulnerability

字符串

启用/禁用 IoT 漏洞查询服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_outbreak_prevention

别名: query-outbreak-prevention

字符串

启用/禁用爆发预防查询服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

query_webfilter

别名: query-webfilter

字符串

启用/禁用 Web 筛选服务

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

webfilter_https_traversal

别名: webfilter-https-traversal

字符串

启用/禁用 Web 筛选 HTTPS 遍历

disable - 禁用设置。

enable - 启用设置。

选项

  • "disable"

  • "enable"

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

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: Enable/disable services provided by the built-in FortiGuard.
      fortinet.fortimanager.fmgr_fmupdate_service:
        # 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, ...]
        fmupdate_service:
          avips: <value in [disable, enable]>
          query_antispam: <value in [disable, enable]>
          query_antivirus: <value in [disable, enable]>
          query_filequery: <value in [disable, enable]>
          query_geoip: <value in [disable, enable]>
          query_outbreak_prevention: <value in [disable, enable]>
          query_webfilter: <value in [disable, enable]>
          webfilter_https_traversal: <value in [disable, enable]>
          query_iot: <value in [disable, enable]>
          query_iot_collection: <value in [disable, enable]>
          query_iot_vulnerability: <value in [disable, enable]>
          query_ioc: <value in [disable, enable]>

返回值

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

键

描述

meta

字典

请求的结果。

返回: always

request_url

字符串

请求的完整 URL。

返回: always

示例: "/sys/login/user"

response_code

整数

api 请求的状态。

返回: always

示例: 0

response_data

列表 / 元素=字符串

api 响应。

返回: always

response_message

字符串

api 响应的描述性消息。

返回: always

示例: "OK."

system_information

字典

目标系统的信息。

返回: always

rc

整数

请求的状态。

返回: always

示例: 0

version_check_warning

列表 / 元素=字符串

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

返回: complex

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)