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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

firewall_service_custom

字典

配置自定义服务。

app_category

列表 / elements=dictionary

应用程序类别 ID。

id

整数 / 必需

应用程序类别 ID。请参阅 <a href=’#notes’>备注</a>。

app_service_type

字符串

应用程序服务类型。

选择

  • "disable"

  • "app-id"

  • "app-category"

application

列表 / elements=dictionary

应用程序 ID。

id

整数 / 必需

应用程序 ID。请参阅 <a href=’#notes’>备注</a>。

category

字符串

服务类别。源 firewall.service.category.name。

check_reset_range

字符串

配置 ICMP 错误消息验证的类型。

选择

  • "disable"

  • "strict"

  • "default"

color

整数

GUI 上图标的颜色。

comment

字符串

注释。

fabric_object

字符串

安全 Fabric 全局对象设置。

选择

  • "enable"

  • "disable"

fqdn

字符串

完全限定的域名。

helper

字符串

助手名称。

选择

  • "auto"

  • "disable"

  • "ftp"

  • "tftp"

  • "ras"

  • "h323"

  • "tns"

  • "mms"

  • "sip"

  • "pptp"

  • "rtsp"

  • "dns-udp"

  • "dns-tcp"

  • "pmap"

  • "rsh"

  • "dcerpc"

  • "mgcp"

  • "gtp-c"

  • "gtp-u"

  • "gtp-b"

  • "pfcp"

icmpcode

整数

ICMP 代码。

icmptype

整数

ICMP 类型。

iprange

字符串

与服务关联的 IP 范围的开始和结束。

name

字符串 / 必需

自定义服务名称。

protocol

字符串

基于 IANA 编号的协议类型。

选择

  • "TCP/UDP/UDP-Lite/SCTP"

  • "ICMP"

  • "ICMP6"

  • "IP"

  • "HTTP"

  • "FTP"

  • "CONNECT"

  • "SOCKS-TCP"

  • "SOCKS-UDP"

  • "ALL"

  • "TCP/UDP/SCTP"

protocol_number

整数

IP 协议号。

proxy

字符串

启用/禁用 Web 代理服务。

选择

  • "enable"

  • "disable"

sctp_portrange

字符串

多个 SCTP 端口范围。

session_ttl

字符串

会话 TTL (300 - 2764800, 0 = 默认值)。

tcp_halfclose_timer

整数

等待关闭等待未应答的 FIN 数据包的 TCP 会话的时间（1 - 86400 秒，0 = 默认值）。

tcp_halfopen_timer

整数

等待关闭等待未应答的打开会话数据包的 TCP 会话的时间（1 - 86400 秒，0 = 默认值）。

tcp_portrange

字符串

多个 TCP 端口范围。

tcp_rst_timer

整数

设置 TCP CLOSE 状态的长度（以秒为单位）（5 - 300 秒，0 = 默认值）。

tcp_timewait_timer

整数

设置 TCP TIME-WAIT 状态的长度（以秒为单位）（1 - 300 秒，0 = 默认值）。

udp_idle_timer

整数

空闲 UDP/UDP-Lite 连接超时前的秒数（0 - 86400 秒，0 = 默认值）。

udp_portrange

字符串

多个 UDP 端口范围。

udplite_portrange

字符串

多个 UDP-Lite 端口范围。

uuid

字符串

通用唯一标识符（UUID；自动分配，但可以手动重置）。

visibility

字符串

启用/禁用 GUI 上服务的可见性。

选择

  • "enable"

  • "disable"

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

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

选择

  • "present"

  • "absent"

state

字符串 / 必需

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

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值： "root"

备注

注意

  • 传统的 fortiosapi 已被弃用，httpapi 是运行剧本的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure custom services.
  fortinet.fortios.fortios_firewall_service_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_service_custom:
          app_category:
              -
                  id: "4"
          app_service_type: "disable"
          application:
              -
                  id: "7"
          category: "<your_own_value> (source firewall.service.category.name)"
          check_reset_range: "disable"
          color: "0"
          comment: "Comment."
          fabric_object: "enable"
          fqdn: "<your_own_value>"
          helper: "auto"
          icmpcode: ""
          icmptype: ""
          iprange: "<your_own_value>"
          name: "default_name_18"
          protocol: "TCP/UDP/UDP-Lite/SCTP"
          protocol_number: "0"
          proxy: "enable"
          sctp_portrange: "<your_own_value>"
          session_ttl: "<your_own_value>"
          tcp_halfclose_timer: "0"
          tcp_halfopen_timer: "0"
          tcp_portrange: "<your_own_value>"
          tcp_rst_timer: "0"
          tcp_timewait_timer: "0"
          udp_idle_timer: "0"
          udp_portrange: "<your_own_value>"
          udplite_portrange: "<your_own_value>"
          uuid: "<your_own_value>"
          visibility: "enable"

返回值

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

键

描述

build

字符串

飞塔固件镜像的构建版本号

返回： 总是

示例： "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)