fortinet.fortios.fortios_endpoint_control_settings 模块 – 配置 Fortinet 的 FortiOS 和 FortiGate 中的终端控制设置。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定： fortinet.fortios.fortios_endpoint_control_settings。

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改 endpoint_control 功能和设置类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括所有参数，在使用前需要将值调整到数据源。已在 FOS v6.0.0 上测试。

要求

执行此模块的主机需要以下要求。

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

endpoint_control_settings

字典

配置终端控制设置。

字符串

下载 FortiClient 的自定义 URL。

download_location

字符串

FortiClient 下载位置（FortiGuard 或自定义）。

选项

  • "fortiguard"

  • "custom"

forticlient_avdb_update_interval

整数

FortiClient 反病毒数据库更新之间的时间间隔（0-24 小时）。

forticlient_dereg_unsupported_client

字符串

启用/禁用注销不受支持的 FortiClient 终端。

选项

  • "enable"

  • "disable"

forticlient_disconnect_unsupported_client

字符串

启用/禁用断开不受支持的 FortiClient 终端的连接。

选项

  • "enable"

  • "disable"

forticlient_ems_rest_api_call_timeout

整数

FortiClient EMS 调用超时时间（以毫秒为单位）（500-30000 毫秒）。

forticlient_keepalive_interval

整数

FortiClient 发送两个 KeepAlive 消息之间的时间间隔（20-300 秒）。

forticlient_offline_grace

字符串

启用/禁用离线注册客户端的宽限期。

选项

  • "enable"

  • "disable"

forticlient_offline_grace_interval

整数

离线注册 FortiClient 的宽限期（60-600 秒）。

forticlient_reg_key

字符串

FortiClient 注册密钥。

forticlient_reg_key_enforce

字符串

启用/禁用要求或强制使用 FortiClient 注册密钥。

选项

  • "enable"

  • "disable"

forticlient_reg_timeout

整数

FortiClient 注册许可证超时时间（天，最小值 = 1，最大值 = 180，0 表示无限期）。

forticlient_sys_update_interval

整数

FortiClient 发送两个系统更新消息之间的时间间隔（30-1440 分钟）。

forticlient_user_avatar

字符串

启用/禁用上传 FortiClient 用户头像。

选项

  • "enable"

  • "disable"

forticlient_warning_interval

整数

FortiClient 门户警告之间的时间间隔（0-24 小时）。

override

字符串

覆盖此 VDOM 的全局 EMS 表。

选项

  • "enable"

  • "disable"

member_path

字符串

要操作的成员属性路径。

如果有多个属性，则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时，将忽略 state 选项。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域，在以前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例，可以将其配置并用作不同的单元。

默认值： "root"

备注

注意

  • 旧版 fortiosapi 已弃用，httpapi 是运行 playbook 的首选方法。

示例

- name: Configure endpoint control settings.
  fortinet.fortios.fortios_endpoint_control_settings:
      vdom: "{{ vdom }}"
      endpoint_control_settings:
          download_custom_link: "<your_own_value>"
          download_location: "fortiguard"
          forticlient_avdb_update_interval: "12"
          forticlient_dereg_unsupported_client: "enable"
          forticlient_disconnect_unsupported_client: "enable"
          forticlient_ems_rest_api_call_timeout: "15000"
          forticlient_keepalive_interval: "150"
          forticlient_offline_grace: "enable"
          forticlient_offline_grace_interval: "300"
          forticlient_reg_key: "<your_own_value>"
          forticlient_reg_key_enforce: "enable"
          forticlient_reg_timeout: "90"
          forticlient_sys_update_interval: "720"
          forticlient_user_avatar: "enable"
          forticlient_warning_interval: "12"
          override: "enable"

返回值

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

键

描述

build

字符串

FortiGate 镜像的版本号。

返回值： 始终

示例： "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法。

返回值： 始终

示例： "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果。

返回值： 始终

示例： "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (ID)。

返回值： 成功

示例： "id"

name

字符串

用于完成请求的表名。

返回值： 始终

示例： "urlfilter"

path

字符串

用于完成请求的表路径。

返回值： 始终

示例： "webfilter"

revision

字符串

内部版本号。

返回值： 始终

示例： "17.0.2.10658"

serial

字符串

设备的序列号。

返回值： 始终

示例： "FGVMEVYYQT3AB5352"

状态

字符串

操作结果指示

返回值： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回值： 始终

示例： "root"

版本

字符串

FortiGate 版本

返回值： 始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆洪斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)