fortinet.fortios.fortios_firewall_internet_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_internet_service_custom

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选择

  • false ← (默认)

  • true

firewall_internet_service_custom

字典

配置自定义互联网服务。

comment

字符串

注释。

disable_entry

列表 / elements=字典

禁用 Internet 服务数据库中的条目。

id

整数 / 必需

禁用条目 ID。请参阅 注释

ip_range

列表 / elements=字典

禁用条目中的 IP 范围。

end_ip

字符串

结束 IP 地址。

id

整数 / 必需

禁用条目范围 ID。请参阅 注释

start_ip

字符串

起始 IP 地址。

port

整数

TCP/IP 端口的整数值(0 - 65535)。

protocol

整数

IANA 定义的协议类型的整数值(0 - 255)。

entry

列表 / elements=字典

添加到 Internet 服务数据库和自定义数据库的条目。

addr_mode

字符串

地址模式(IPv4 或 IPv6)。

选择

  • "ipv4"

  • "ipv6"

dst

列表 / elements=字典

目标地址或地址组名称。

name

字符串 / 必需

从可用选项中选择目标地址或地址组对象。源 firewall.address.name firewall .addrgrp.name。

dst6

列表 / elements=字典

目标地址 6 或地址 6 组名称。

name

字符串 / 必需

从可用选项中选择目标地址 6 或地址组对象。源 firewall.address6.name firewall .addrgrp6.name。

id

整数 / 必需

条目 ID(1-255)。请参阅 注释

port_range

列表 / elements=字典

自定义条目中的端口范围。

end_port

整数

范围(0 到 65535)中结束 TCP/UDP/SCTP 目标端口的整数值。

id

整数 / 必需

自定义条目端口范围 ID。请参阅 注释

start_port

整数

范围(0 到 65535)中起始 TCP/UDP/SCTP 目标端口的整数值。

protocol

整数

IANA 定义的协议类型的整数值(0 - 255)。

master_service_id

整数

Internet 服务数据库中的 Internet 服务 ID。源 firewall.internet-service.id。

name

字符串 / 必需

Internet 服务名称。

reputation

整数

自定义 Internet 服务的信誉级别。源 firewall.internet-service-reputation.id。

member_path

字符串

要操作的成员属性路径。

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

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

member_state

字符串

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

当指定 member_state 时,将忽略 state 选项。

选择

  • "present"

  • "absent"

state

字符串 / 必需

指示是否创建或删除对象。

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure custom Internet Services.
  fortinet.fortios.fortios_firewall_internet_service_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_internet_service_custom:
          comment: "Comment."
          disable_entry:
              -
                  id: "5"
                  ip_range:
                      -
                          end_ip: "<your_own_value>"
                          id: "8"
                          start_ip: "<your_own_value>"
                  port: "32767"
                  protocol: "127"
          entry:
              -
                  addr_mode: "ipv4"
                  dst:
                      -
                          name: "default_name_15 (source firewall.address.name firewall.addrgrp.name)"
                  dst6:
                      -
                          name: "default_name_17 (source firewall.address6.name firewall.addrgrp6.name)"
                  id: "18"
                  port_range:
                      -
                          end_port: "65535"
                          id: "21"
                          start_port: "1"
                  protocol: "0"
          master_service_id: "2147483647"
          name: "default_name_25"
          reputation: "3"

返回值

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

描述

build

字符串

FortiGate 映像的版本号

返回: 总是

示例: "1547"

http_method

字符串

上次用于将内容配置到 FortiGate 中的方法

返回: 总是

示例: "PUT"

http_status

字符串

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

返回: 总是

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主键 (id)

返回: 成功

示例: "id"

name

字符串

用于完成请求的表名称

返回: 总是

示例: "urlfilter"

path

字符串

用于完成请求的表的路径

返回: 总是

示例: "webfilter"

revision

字符串

内部修订号

返回: 总是

示例: "17.0.2.10658"

序列号

字符串

设备的序列号

返回: 总是

示例: "FGVMEVYYQT3AB5352"

状态

字符串

操作结果的指示

返回: 总是

示例: "success"

vdom

字符串

使用的虚拟域

返回: 总是

示例: "root"

版本

字符串

FortiGate的版本

返回: 总是

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)