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

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够通过允许用户设置和修改系统功能和 session_helper 类别来配置 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"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

system_session_helper

字典

配置会话助手。

id

整数 / 必需

会话助手 ID。请参阅 <a href=’#notes’>说明</a>。

name

字符串

助手名称。

选项

  • "ftp"

  • "tftp"

  • "ras"

  • "h323"

  • "tns"

  • "mms"

  • "sip"

  • "pptp"

  • "rtsp"

  • "dns-udp"

  • "dns-tcp"

  • "pmap"

  • "rsh"

  • "dcerpc"

  • "mgcp"

  • "gtp-c"

  • "gtp-u"

  • "gtp-b"

  • "pfcp"

port

整数

协议端口。

protocol

整数

协议号。

vdom

字符串

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

默认值： "root"

说明

注意

  • 我们强烈建议您使用自己的值作为 id，而不是 0，因为 '0' 是一个特殊的占位符，允许后端为对象分配最新的可用编号，但它确实有限制。请在问答中找到更多详细信息。

  • 传统的 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方法

  • 该模块支持 check_mode。

示例

- name: Configure session helper.
  fortinet.fortios.fortios_system_session_helper:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_session_helper:
          id: "3"
          name: "default_name_4"
          port: "0"
          protocol: "0"

返回值

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

键

描述

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)