f5networks.f5_modules.bigip_gtm_topology_record 模块 – 管理 GTM 拓扑记录

注意

此模块是 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_gtm_topology_record。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 GTM（现在为 BIG-IP DNS）拓扑记录。创建后，只能修改拓扑记录 weight。

参数

参数	注释
destination 字典 / 必需	指定系统将传入的 DNS 请求定向到何处。
continent 字符串	指定七大洲之一，以及 Unknown 设置。 如果系统无法确定发出请求的本地 DNS 的位置，则指定 Unknown 会强制系统使用默认解析。 支持完整的洲名称及其缩写版本。
country 字符串	指定一个国家/地区。 支持完整的洲名称及其缩写版本。
datacenter 字符串	指定配置中已定义的 GTM 数据中心的名称。
geo_isp 字符串	指定地理位置 ISP
isp 字符串	指定互联网服务提供商。 选择 "AOL" "BeijingCNC" "CNC" "ChinaEducationNetwork" "ChinaMobilNetwork" "ChinaRailwayTelcom" "ChinaTelecom" "ChinaUnicom" "Comcast" "Earthlink" "ShanghaiCNC" "ShanghaiTelecom"
negate 布尔值	当设置为 true 时，当请求目标不匹配时，系统会选择此拓扑记录。 选择 false ← (默认) true
pool 字符串	指定配置中已定义的 GTM 池的名称。
region 字符串	指定配置中已定义的区域的名称。
state 字符串	指定给定国家/地区中的一个州。 此参数需要 country 选项。
subnet 字符串	CIDR 格式的 IP 地址和网络掩码。
partition 字符串	要在其上管理资源的设备分区。 当与 pool、data_center 和 region 参数结合使用时，会考虑分区参数，否则将忽略它。 默认值： "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 ← (默认)
source 字典 / 必需	指定传入 DNS 请求的来源。
continent 字符串	指定七大洲之一，以及 Unknown 设置。 如果系统无法确定发出请求的本地 DNS 的位置，则指定 Unknown 会强制系统使用默认解析。 支持完整的洲名称及其缩写版本。
country 字符串	指定一个国家/地区。 除了国家全名外，您还可以指定它们的缩写形式，例如使用 US 而不是 United States。 有效的国家代码可以在这里找到：https://countrycode.org/。
geo_isp 字符串	指定地理位置 ISP。
isp 字符串	指定互联网服务提供商。 选择 "AOL" "BeijingCNC" "CNC" "ChinaEducationNetwork" "ChinaMobilNetwork" "ChinaRailwayTelcom" "ChinaTelecom" "ChinaUnicom" "Comcast" "Earthlink" "ShanghaiCNC" "ShanghaiTelecom"
negate 布尔值	当设置为 c(true) 时，如果请求源不匹配，系统将选择此拓扑记录。 选择 false ← (默认) true
region 字符串	指定配置中已定义的区域的名称。
state 字符串	指定给定国家/地区中的一个州。 此参数需要 country 选项。
subnet 字符串	CIDR 格式的 IP 地址和网络掩码。
state 字符串	当 state 为 present 时，确保记录存在。 当 state 为 absent 时，确保记录被删除。 选择 "present" ← (默认) "absent"
weight 整数	指定拓扑记录的权重。 系统查找与服务器对象（池或池成员）和本地 DNS 匹配的第一个拓扑记录的权重。然后，系统将该权重分配为该服务器对象的拓扑得分。 系统将负载均衡到具有最高拓扑得分的服务器对象。 如果系统找不到既匹配服务器对象又匹配本地 DNS 的拓扑记录，则系统将为该服务器对象分配零分。 如果在创建记录时未指定此选项，系统会将其设置为默认值 1 有效范围是 (0 - 4294967295)

说明

注意

• 有关使用 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 IP Subnet and an ISP based topology record
  bigip_gtm_topology_record:
    source:
      - subnet: 192.168.1.0/24
    destination:
      - isp: AOL
    weight: 10
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a region and a pool based topology record
  bigip_gtm_topology_record:
    source:
      - region: Foo
    destination:
      - pool: FooPool
    partition: FooBar
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a negative region and a negative data center based topology record
  bigip_gtm_topology_record:
    source:
      - region: Baz
      - negate: true
    destination:
      - datacenter: Baz-DC
      - negate: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
weight 整数	拓扑记录的权重。 返回: changed 示例: 20

作者

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库 (源代码)