fortinet.fortios.fortios_system_probe_response 模块 – 在 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_system_probe_response。

在 fortinet.fortios 2.0.0 中新增

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选项

  • "present"

  • "absent"

system_probe_response

字典

配置系统探测响应。

http_probe_value

字符串

要响应监控服务器的值。

mode

字符串

SLA 响应模式。

选项

  • "none"

  • "http-probe"

  • "twamp"

password

字符串

身份验证模式下的 TWAMP 响应程序密码。

port

整数

要响应的端口号。

security_mode

字符串

TWAMP 响应程序安全模式。

选项

  • "none"

  • "authentication"

timeout

整数

twamp 测试会话的非活动计时器。

ttl_mode

字符串

TWAMP 数据包 TTL 修改模式。

选项

  • "reinit"

  • "decrease"

  • "retain"

vdom

字符串

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

默认： "root"

注释

注意

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

示例

- name: Configure system probe response.
  fortinet.fortios.fortios_system_probe_response:
      vdom: "{{ vdom }}"
      system_probe_response:
          http_probe_value: "<your_own_value>"
          mode: "none"
          password: "<your_own_value>"
          port: "8008"
          security_mode: "none"
          timeout: "300"
          ttl_mode: "reinit"

返回值

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

键

描述

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"

status

字符串

操作结果的指示

已返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

已返回： 始终

示例： "root"

version

字符串

FortiGate 的版本

已返回： 始终

示例： "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)