fortinet.fortios.fortios_firewall_address 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 IPv4 地址。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

摘要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_address

字典

配置 IPv4 地址。

allow_routing

字符串

启用/禁用在此路由配置中使用此地址。

选项

  • "enable"

  • "disable"

associated_interface

字符串

与地址关联的网络接口。来源 system.interface.name system.zone.name。

cache_ttl

整数

定义 FQDN 缓存中单个 IP 地址的最小 TTL（以秒为单位）。

clearpass_spt

字符串

SPT（系统姿态令牌）值。

选项

  • "unknown"

  • "healthy"

  • "quarantine"

  • "checkup"

  • "transient"

  • "infected"

color

整数

GUI 上图标的颜色。

comment

字符串

注释。

country

字符串

与特定国家/地区关联的 IP 地址。

end_ip

字符串

地址范围内最后一个 IP 地址（包含）。

end_mac

字符串

范围内最后一个 MAC 地址。

epg_name

字符串

端点组名称。

fabric_object

字符串

安全结构全局对象设置。

选项

  • "enable"

  • "disable"

filter

字符串

匹配条件过滤器。

fqdn

字符串

完全限定域名地址。

fsso_group

列表 / 元素=字典

FSSO 组。

name

字符串 / 必需

FSSO 组名称。来源 user.adgrp.name。

hw_model

字符串

动态地址匹配硬件型号。

hw_vendor

字符串

动态地址匹配硬件厂商。

interface

字符串

将使用其 IP 地址的接口名称。来源 system.interface.name。

list

列表 / 元素=字典

IP 地址列表。

ip

字符串 / 必需

IP。

net_id

字符串

网络 ID。

obj_id

字符串

对象 ID。

macaddr

列表 / 元素=字典

多个 MAC 地址范围。

macaddr

字符串 / 必需

MAC 地址范围 <start>[-<end>]，用空格分隔。

name

字符串 / 必需

地址名称。

node_ip_only

字符串

启用/禁用仅在 Kubernetes 中收集节点地址。

选项

  • "enable"

  • "disable"

obj_id

字符串

NSX 的对象 ID。

obj_tag

字符串

动态地址对象的标签。

obj_type

字符串

对象类型。

选项

  • "ip"

  • "mac"

organization

字符串

组织域名（语法：organization/domain）。

os

字符串

动态地址匹配操作系统。

policy_group

字符串

策略组名称。

route_tag

整数

路由标签地址。

sdn

字符串

SDN。来源 system.sdn-connector.name。

sdn_addr_type

字符串

要收集的地址类型。

选项

  • "private"

  • "public"

  • "all"

sdn_tag

字符串

SDN 标签。

start_ip

字符串

地址范围内第一个 IP 地址（包含）。

start_mac

字符串

范围内第一个 MAC 地址。

sub_type

字符串

地址的子类型。

选项

  • "sdn"

  • "clearpass-spt"

  • "fsso"

  • "ems-tag"

  • "fortivoice-tag"

  • "fortinac-tag"

  • "fortipolicy-tag"

  • "swc-tag"

  • "device-identification"

subnet

字符串

地址的 IP 地址和子网掩码。

subnet_name

字符串

子网名称。

sw_version

字符串

动态地址匹配软件版本。

tag_detection_level

字符串

动态地址对象的标签检测级别。

tag_type

字符串

动态地址对象的标签类型。

tagging

列表 / 元素=字典

配置对象标记。

category

字符串

标签类别。来源 system.object-tagging.category。

name

字符串 / 必需

标签条目名称。

tags

列表 / 元素=字典

标签。

name

字符串 / 必需

标签名称。来源 system.object-tagging.tags.name。

tenant

字符串

租户。

type

字符串

地址类型。

选项

  • "ipmask"

  • "iprange"

  • "fqdn"

  • "geography"

  • "wildcard"

  • "dynamic"

  • "interface-subnet"

  • "mac"

  • "route-tag"

  • "wildcard-fqdn"

uuid

字符串

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

visibility

字符串

启用/禁用 GUI 中的地址可见性。

选项

  • "enable"

  • "disable"

wildcard

字符串

IP 地址和通配符网络掩码。

wildcard_fqdn

字符串

带有通配符字符的完全限定域名。

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 IPv4 addresses.
  fortinet.fortios.fortios_firewall_address:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_address:
          allow_routing: "enable"
          associated_interface: "<your_own_value> (source system.interface.name system.zone.name)"
          cache_ttl: "0"
          clearpass_spt: "unknown"
          color: "0"
          comment: "Comment."
          country: "<your_own_value>"
          end_ip: "<your_own_value>"
          end_mac: "<your_own_value>"
          epg_name: "<your_own_value>"
          fabric_object: "enable"
          filter: "<your_own_value>"
          fqdn: "<your_own_value>"
          fsso_group:
              -
                  name: "default_name_17 (source user.adgrp.name)"
          hw_model: "<your_own_value>"
          hw_vendor: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          list:
              -
                  ip: "<your_own_value>"
                  net_id: "<your_own_value>"
                  obj_id: "<your_own_value>"
          macaddr:
              -
                  macaddr: "<your_own_value>"
          name: "default_name_27"
          node_ip_only: "enable"
          obj_id: "<your_own_value>"
          obj_tag: "<your_own_value>"
          obj_type: "ip"
          organization: "<your_own_value>"
          os: "<your_own_value>"
          policy_group: "<your_own_value>"
          route_tag: "0"
          sdn: "<your_own_value> (source system.sdn-connector.name)"
          sdn_addr_type: "private"
          sdn_tag: "<your_own_value>"
          start_ip: "<your_own_value>"
          start_mac: "<your_own_value>"
          sub_type: "sdn"
          subnet: "<your_own_value>"
          subnet_name: "<your_own_value>"
          sw_version: "<your_own_value>"
          tag_detection_level: "<your_own_value>"
          tag_type: "<your_own_value>"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_49"
                  tags:
                      -
                          name: "default_name_51 (source system.object-tagging.tags.name)"
          tenant: "<your_own_value>"
          type: "ipmask"
          uuid: "<your_own_value>"
          visibility: "enable"
          wildcard: "<your_own_value>"
          wildcard_fqdn: "<your_own_value>"

返回值

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

键

描述

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)

  • 薛杰 (@JieX19)

  • 卢宏斌 (@fgtdev-hblu)

  • 沈峰 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)