f5networks.f5_modules.bigip_gtm_dns_listener 模块 – 配置 BIG-IP DNS 系统以响应 TCP 或 UDP DNS 请求

注意

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

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

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在剧本中使用它，请指定：f5networks.f5_modules.bigip_gtm_dns_listener。

f5networks.f5_modules 1.4.0 中的新增功能

概要

• 定义一个或多个侦听器对象，以控制 BIG-IP DNS 系统可用于处理 DNS 请求的协议。

• BIG-IP DNS 侦听器允许 TCP 和 UDP 协议。

参数

参数	注释
address 字符串 / 必需	指定系统监听的 IP 地址。
advertise 布尔值	指定是否将此侦听器的地址通告给周围的路由器。 选项 false true
auto_lasthop 字符串	指定是否自动为池映射最后一跳。
description 字符串	提供 DNS 侦听器的简短描述。
disabled_vlans 列表 / 元素=字符串	要禁用的 VLAN 列表。如果 VLAN 中未指定分区，则将使用此模块的 partition 选项。 此参数与 enabled_vlans 参数互斥。
enabled_vlans 列表 / 元素=字符串	要启用的 VLAN 列表。当使用名为 all 的 VLAN 时，将允许所有 VLAN。VLAN 可以使用或不使用前导分区来指定。如果 VLAN 中未指定分区，则将使用此模块的 partition 选项。 此参数与 disabled_vlans 参数互斥。
fallback_persistence 字符串	指定侦听器在默认持久性配置文件不可用时使用的回退持久性配置文件。
ip_protocol 字符串	指定此侦听器接收网络流量的协议。
irules 列表 / 元素=字符串	指定要在侦听器上运行的 iRule 列表。 iRule 有助于自动化应用程序流量的拦截、处理和路由。 如果要删除现有的 iRule，请提供一个空列表值；[]。请参阅文档以了解示例。
last_hop_pool 字符串	指定侦听器要用于将回复流量定向到最后一跳路由器的最后一跳池的名称。
mask 字符串	仅为网络侦听器指定网络掩码。 网络掩码阐明主机位是实际的零还是通配符表示。
name 字符串 / 必需	指定 DNS 侦听器的名称。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
pool 字符串	指定侦听器自动将流量定向到的默认池。
port 整数	指定侦听器监听连接的端口。 有效值范围介于 0 和 65535（含）之间。
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。 此选项在使用 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_port 字符串	指定系统是否保留连接的源端口。
state 字符串	DNS 侦听器状态。 当为 present 时，确保创建并启用池。 当为 absent 时，确保从系统中删除池。 当启用 enabled 或禁用 disabled 时，分别确保远程设备上的池启用或禁用。 选项 "present" ← (默认) "absent" "enabled" "disabled"
translate_address 布尔值	启用或禁用监听器的地址转换。 选项 false true
translate_port 布尔值	启用或禁用端口转换。 选项 false true

注释

注意

• 有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

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

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

示例

- name: 'Create DNS Listener'
  bigip_gtm_dns_listener:
    address: '192.0.1.0'
    advertise: false
    auto_lasthop: default
    description: 'this is a test DNS listener'
    enabled_vlans:
      - /Common/external
    ip_protocol: tcp
    irules:
      - /Common/irule1
    mask: '255.255.255.0'
    pool: /Common/webpool
    name: test-dns-listener
    port: 30025
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
    source_port: preserve
    state: present
    translate_address: true
    translate_port: true
  delegate_to: localhost

- name: 'Disable a DNS Listener'
  bigip_gtm_dns_listener:
    address: '192.0.1.0'
    state: disabled
    name: test-dns-listener
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
address 字符串	系统监听的 IP 地址。 返回： changed 示例： "10.0.0.2"
advertise 布尔值	指定监听器是否向周围路由器发布。 返回： changed 示例： true
auto_lasthop 字符串	显示系统是否自动为池映射最后一跳。 返回： changed 示例： "default"
disabled_vlans 列表 / 元素=字符串	虚拟机禁用的 VLAN 列表。 返回： changed 示例： ["/Common/vlan1", "/Common/vlan2"]
enabled 布尔值	提供 DNS 监听器状态。 返回： changed 示例： true
enabled_vlans 列表 / 元素=字符串	虚拟机启用的 VLAN 列表。 返回： changed 示例： ["/Common/vlan5", "/Common/vlan6"]
fallback_persistence 字符串	当默认持久性配置文件不可用时，监听器使用的回退持久性配置文件。 返回： changed 示例： "/Common/fallback-profile"
ip_protocol 字符串	DNS 监听器使用的 IP 协议。 返回： changed 示例： "tcp"
irules 列表 / 元素=字符串	DNS 监听器运行的规则列表。 返回： changed 示例： ["/Common/rule1", "/Common/rule2"]
mask 字符串	监听器用于标识地址范围的子网掩码。 返回： changed 示例： "255.255.0.0"
name 字符串	DNS 监听器名称。 返回： changed 示例： "test-dns-listener"
port 整数	系统监听的端口。 返回： changed 示例： 53
source_port 字符串	指定系统是否保留连接的源端口。 返回： changed 示例： "preserve"
translate_address 字符串	指定是否启用地址转换。 返回： changed 示例： "enabled"
translate_port 字符串	指定是否启用端口转换。 返回： changed 示例： "enabled"

作者

• Andrey Kashcheev (@andreykashcheev)

集合链接

• 问题追踪器
• 主页
• 代码库 (源码)