fortinet.fortios.fortios_firewall_proxy_addrgrp 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 Web 代理地址组。

注意

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

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

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

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

firewall_proxy_addrgrp

字典

配置 Web 代理地址组。

color

整数

确定 GUI 中图标颜色的整数值 (1 - 32)。

comment

字符串

可选注释。

member

列表 / 元素=字典

地址组的成员。

name

字符串 / 必需

地址名称。来源 firewall.proxy-address.name firewall.proxy-addrgrp.name。

name

字符串 / 必需

地址组名称。

tagging

列表 / 元素=字典

配置对象标记。

category

字符串

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

name

字符串 / 必需

标记条目名称。

tags

列表 / 元素=字典

标签。

name

字符串 / 必需

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

type

字符串

源地址组或目标地址组类型。

选项

  • "src"

  • "dst"

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 web proxy address group.
  fortinet.fortios.fortios_firewall_proxy_addrgrp:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_proxy_addrgrp:
          color: "0"
          comment: "Optional comments."
          member:
              -
                  name: "default_name_6 (source firewall.proxy-address.name firewall.proxy-addrgrp.name)"
          name: "default_name_7"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_10"
                  tags:
                      -
                          name: "default_name_12 (source system.object-tagging.tags.name)"
          type: "src"
          uuid: "<your_own_value>"
          visibility: "enable"

返回值

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

键

描述

build

字符串

Fortigate 镜像的构建编号

返回： 始终

示例： "1547"

http_method

字符串

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

返回： 始终

示例： "PUT"

http_status

字符串

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

返回： 始终

示例： "200"

mkey

字符串

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

返回： 成功

示例： "id"

name

字符串

用于完成请求的表的名称

返回： 始终

示例： "urlfilter"

路径

字符串

用于完成请求的表格路径

返回： 始终

示例： "webfilter"

版本号

字符串

内部版本号

返回： 始终

示例： "17.0.2.10658"

序列号

字符串

设备的序列号

返回： 始终

示例： "FGVMEVYYQT3AB5352"

状态

字符串

操作结果指示

返回： 始终

示例： "success"

vdom

字符串

使用的虚拟域

返回： 始终

示例： "root"

版本

字符串

FortiGate 的版本

返回： 始终

示例： "v5.6.3"

作者

  • 郑链 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆宏斌 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)