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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ←（默认）

  • true

firewall_addrgrp

字典

配置 IPv4 地址组。

allow_routing

字符串

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

选项

  • "enable"

  • "disable"

category

字符串

地址组类别。

选项

  • "default"

  • "ztna-ems-tag"

  • "ztna-geo-tag"

color

整数

GUI 上图标的颜色。

comment

字符串

注释。

exclude

字符串

启用/禁用地址排除。

选项

  • "enable"

  • "disable"

exclude_member

列表 / elements=字典

地址排除成员。

name

字符串 / 必需

地址名称。源 firewall.address.name firewall.addrgrp.name。

fabric_object

字符串

安全 Fabric 全局对象设置。

选项

  • "enable"

  • "disable"

member

列表 / elements=字典

组中包含的地址对象。

name

字符串 / 必需

地址名称。源 firewall.address.name firewall.addrgrp.name。

name

字符串 / 必需

地址组名称。

tagging

列表 / elements=字典

配置对象标记。

category

字符串

标记类别。源 system.object-tagging.category。

name

字符串 / 必需

标记条目名称。

tags

列表 / elements=字典

标记。

name

字符串 / 必需

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

type

字符串

地址组类型。

选项

  • "default"

  • "folder"

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 是运行 playbook 的首选方式

  • 该模块支持 check_mode。

示例

- name: Configure IPv4 address groups.
  fortinet.fortios.fortios_firewall_addrgrp:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_addrgrp:
          allow_routing: "enable"
          category: "default"
          color: "0"
          comment: "Comment."
          exclude: "enable"
          exclude_member:
              -
                  name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
          fabric_object: "enable"
          member:
              -
                  name: "default_name_12 (source firewall.address.name firewall.addrgrp.name)"
          name: "default_name_13"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_16"
                  tags:
                      -
                          name: "default_name_18 (source system.object-tagging.tags.name)"
          type: "default"
          uuid: "<your_own_value>"
          visibility: "enable"

返回值

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

键

描述

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)