f5networks.f5_modules.bigip_gtm_pool 模块 – 管理 F5 BIG-IP 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_pool。

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 F5 BIG-IP GTM（现在是 BIG-IP DNS）池。

参数

参数

注释

alternate_lb_method

字符串

如果 preferred_lb_method 在选择池时失败，系统尝试的负载平衡模式。

选项

  • "round-robin"

  • "return-to-dns"

  • "none"

  • "ratio"

  • "topology"

  • "static-persistence"

  • "global-availability"

  • "virtual-server-capacity"

  • "packet-rate"

  • "drop-packet"

  • "fallback-ip"

  • "virtual-server-score"

availability_requirements

字典

如果您激活了多个运行状况监视器，则指定必须收到成功响应的运行状况监视器数量，才能将该链接视为可用。

at_least

整数

指定在将链接视为可用之前必须成功的最小活动运行状况监视器数量。

仅当使用 type 为 at_least 时，此参数才相关。

如果使用 all 或 require 类型，则将忽略此参数。

number_of_probers

整数

指定在运行探测时应使用的探测器数量。

在创建新的虚拟服务器时，如果指定此参数，则还必须指定 number_of_probes 参数。

此参数的值应始终大于或等于 number_of_probers 的值。

仅当使用 type 为 require 时，此参数才相关。

如果使用 all 或 at_least 类型，则将忽略此参数。

number_of_probes

整数

指定要声明此服务器已启动必须成功的最小探测数。

在创建新的虚拟服务器时，如果指定此参数，则还必须指定 number_of_probers 参数。

此参数的值应始终小于或等于 number_of_probers 的值。

仅当使用 type 为 require 时，此参数才相关。

如果使用 all 或 at_least 类型，则将忽略此参数。

type

字符串 / 必需

指定 monitors 时的监视器规则类型。

创建新池时，如果未指定此值，将使用默认值“all”。

选项

  • "all"

  • "at_least"

  • "require"

fallback_ip

字符串

指定当系统无法使用其池之一来执行操作时，系统将请求定向到的服务器的 IPv4 或 IPv6 地址。请注意，仅当您选择 fallback_ip 负载平衡方法时，系统才会使用回退 IP。

fallback_lb_method

字符串

如果 preferred_lb_method 和 alternate_lb_method 在选择池时都失败，系统尝试的负载平衡模式。

选项

  • "round-robin"

  • "return-to-dns"

  • "ratio"

  • "topology"

  • "static-persistence"

  • "global-availability"

  • "virtual-server-capacity"

  • "least-connections"

  • "lowest-round-trip-time"

  • "fewest-hops"

  • "packet-rate"

  • "cpu"

  • "completion-rate"

  • "quality-of-service"

  • "kilobytes-per-second"

  • "drop-packet"

  • "fallback-ip"

  • "virtual-server-score"

  • "none"

max_answers_returned

整数

指定系统在响应中列出的最大可用虚拟服务器数。

最大值为 500。

members

列表 / 元素=字典

要分配给池的成员。

此列表中成员的顺序是它们在池中列出的顺序。

server

字符串 / 必需

池成员所属的服务器名称。

virtual_server

字符串 / 必需

与服务器关联的虚拟服务器名称，池成员是该虚拟服务器的一部分。

monitors

列表 / 元素=字符串

指定系统当前用于监视此资源的运行状况监视器。

当 availability_requirements.type 为 require 时，monitors 列表中只能有一个监视器。

name

字符串 / 必需

GTM 池的名称。

partition

字符串

设备分区以管理资源。

默认值： "Common"

preferred_lb_method

字符串

系统首先尝试的负载平衡模式。

选项

  • "round-robin"

  • "return-to-dns"

  • "ratio"

  • "topology"

  • "static-persistence"

  • "global-availability"

  • "virtual-server-capacity"

  • "least-connections"

  • "lowest-round-trip-time"

  • "fewest-hops"

  • "packet-rate"

  • "cpu"

  • "completion-rate"

  • "quality-of-service"

  • "kilobytes-per-second"

  • "drop-packet"

  • "fallback-ip"

  • "virtual-server-score"

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

超时

整数

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

传输方式

字符串

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

选项

  • "rest" ← (默认)

用户名

字符串 / 必需

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

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

验证证书

布尔值

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

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

选项

  • false

  • true ← (默认)

状态

字符串

池状态。当为 present 时，确保创建并启用池。当为 absent 时，确保从系统中删除池。当为 enabled 或 disabled 时，确保在远程设备上启用或禁用（相应地）池。

选项

  • "present" ← (默认)

  • "absent"

  • "enabled"

  • "disabled"

ttl

整数

指定 IP 地址（一旦找到）有效的秒数。

type

字符串 / 必需

您要创建的 GTM 池的类型。

选项

  • "a"

  • "aaaa"

  • "cname"

  • "mx"

  • "naptr"

  • "srv"

注释

注意

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

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

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

示例

- name: Create a GTM pool
  bigip_gtm_pool:
    name: my_pool
    type: a
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Disable pool
  bigip_gtm_pool:
    state: disabled
    name: my_pool
    type: a
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

键

描述

alternate_lb_method

字符串

池的新备用负载均衡方法。

已返回： 已更改

示例： "drop-packet"

fallback_ip

字符串

使用 fallback_ip 方法进行负载均衡时使用的新回退 IP。

已返回： 已更改

示例： "10.10.10.10"

fallback_lb_method

字符串

池的新回退负载均衡方法。

已返回： 已更改

示例： "fewest-hops"

max_answers_returned

整数

新的最大返回答案值。

已返回： 已更改

示例： 25

members

复杂

池中的成员列表。

已返回： 已更改

server

字符串

成员的服务器部分的名称。

已返回： 已更改

virtual_server

字符串

成员的虚拟服务器部分的名称。

已返回： 已更改

monitors

列表 / 元素=字符串

资源的新监视器列表。

已返回： 已更改

示例： ["/Common/monitor1", "/Common/monitor2"]

preferred_lb_method

字符串

池的新首选负载均衡方法。

已返回： 已更改

示例： "topology"

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)