f5networks.f5_modules.bigip_firewall_address_list 模块 – 管理 BIG-IP AFM 上的地址列表

注意

此模块是 f5networks.f5_modules 集合(版本 1.32.1)的一部分。

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

要安装它,请使用:ansible-galaxy collection install f5networks.f5_modules

要在 playbook 中使用它,请指定:f5networks.f5_modules.bigip_firewall_address_list

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP 上的 AFM(高级防火墙管理器)地址列表。此模块可用于添加和删除地址列表条目。

参数

参数

注释

address_lists

列表 / 元素=字符串

要添加到此列表的现有地址列表的简单列表。地址列表可以指定为完全限定名称(/Common/foo)或短名称(foo)。如果使用短名称,则 partition 参数将自动附加到短名称。

address_ranges

列表 / 元素=字符串

地址范围列表,其中范围以端口号开头,后跟一个短划线(-),然后是第二个数字。

如果第一个地址大于第二个数字,则数字将反转,以便正确格式化。例如,2.2.2.2-1.1.1 将变为 1.1.1.1-2.2.2.2

addresses

列表 / 元素=字符串

要添加到列表的单个地址。这些地址与范围和列表的列表不同,例如 address_rangesaddress_lists 中分别使用的地址。

此列表还可以包括具有 CIDR 表示法的网络。

description

字符串

地址列表的描述。

fqdns

列表 / 元素=字符串

完全限定域名 (FQDN) 列表。

FQDN 中至少有一个小数点,将主机与域分开。

要将 FQDN 添加到列表,需要配置全局 FQDN 解析器。这必须使用 bigip_command 或 BIG-IP 的 GUI 完成。如果使用 bigip_command,您可以使用 tmsh modify security firewall global-fqdn-policy FOO 来执行此操作,其中 FOO 是在 tmsh create net dns-resolver FOO 中配置的 DNS 解析器。

geo_locations

列表 / 元素=字典

countryregion 指定的地理位置列表。

country

字符串 / 必需

要使用的地理位置的国家/地区名称或代码。

除了国家/地区的完整名称外,您还可以指定它们的缩写形式,例如 US 而不是 United States

可以在此处找到有效的国家/地区代码 https://countrycode.org/

region

字符串

要使用的国家/地区的区域名称。

name

字符串 / 必需

指定地址列表的名称。

partition

字符串

用于管理资源的设备分区。

默认值: "Common"

provider

字典

在 f5networks.f5_modules 1.0.0 中添加

包含连接详细信息的字典对象。

auth_provider

字符串

配置身份验证提供程序以从远程设备获取身份验证令牌。

此选项在处理 BIG-IQ 设备时真正使用。

no_f5_teem

布尔值

如果为 yes,则不会将 TEEM 遥测数据发送到 F5。

您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。

先前使用的变量 F5_TEEM 已被弃用,因为它的名称令人困惑。

选项

  • false ← (默认值)

  • true

password

别名: pass, pwd

字符串 / 必需

用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。

您可以通过设置环境变量 F5_PASSWORD 来省略此选项。

server

字符串 / 必需

BIG-IP 主机或 BIG-IQ 主机。

您可以通过设置环境变量 F5_SERVER 来省略此选项。

server_port

整数

BIG-IP 服务器端口。

您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。

默认值: 443

timeout

整数

指定与网络设备通信(用于连接或发送命令)的超时时间(以秒为单位)。如果在操作完成之前超出超时时间,模块将出错。

transport

字符串

配置连接到远程设备时使用的传输连接。

选项

  • "rest" ← (默认)

user

字符串 / 必需

连接到 BIG-IP 或 BIG-IQ 的用户名。该用户必须在设备上拥有管理权限。

您可以通过设置环境变量 F5_USER 来省略此选项。

validate_certs

布尔值

如果为 no,则不验证 SSL 证书。仅在个人控制的站点上使用自签名证书时才使用此选项。

您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。

选项

  • false

  • true ← (默认)

state

字符串

当为 present 时,确保地址列表和条目存在。

当为 absent 时,确保删除地址列表。

选项

  • "present" ← (默认)

  • "absent"

说明

注意

  • 有关使用 Ansible 管理 F5 Networks 设备的更多信息,请参阅 https://ansible.org.cn/integrations/networks/f5

  • 需要 BIG-IP 软件版本 >= 12。

  • F5 模块仅操作 F5 产品的运行配置。要确保 BIG-IP 的特定配置持久保存到磁盘,请务必包含至少一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用该模块以保存运行配置的方法,请参阅该模块的文档。

示例

- name: Create an address list
  bigip_firewall_address_list:
    name: foo
    addresses:
      - 3.3.3.3
      - 4.4.4.4
      - 5.5.5.5
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

通用返回值记录在此处,以下是此模块特有的字段

Key

描述

address_lists

列表 / 元素=字符串

应用于地址列表的新的地址列表名称列表。

已返回: changed

示例: ["/Common/list1", "/Common/list2"]

address_ranges

列表 / 元素=字符串

应用于地址列表的新的地址范围列表。

已返回: changed

示例: ["1.1.1.1-2.2.2.2", "3.3.3.3-4.4.4.4"]

addresses

列表 / 元素=字符串

应用于地址列表的新的地址列表。

已返回: changed

示例: ["1.1.1.1", "2.2.2.2"]

description

字符串

地址列表的新描述。

已返回: changed

示例: "我的地址列表"

fqdns

列表 / 元素=字符串

应用于地址列表的新的 FQDN 名称列表。

已返回: changed

示例: ["google.com", "mit.edu"]

geo_locations

complex

应用于地址列表的新的地理位置列表。

已返回: changed

country

字符串

地理位置的国家/地区。

已返回: changed

示例: "US"

region

字符串

地理位置的地区。

已返回: changed

示例: "California"

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)