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。

要在剧本中使用它，请指定：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 未能选择池，则系统尝试使用的负载均衡模式。

选项

  • "轮询"

  • "返回DNS"

  • "无"

  • "比率"

  • "拓扑"

  • "静态持久性"

  • "全局可用性"

  • "虚拟服务器容量"

  • "数据包速率"

  • "丢弃数据包"

  • "回退IP"

  • "虚拟服务器评分"

availability_requirements

字典

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

至少

整数

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

此参数仅在使用 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”。

选项

  • "全部"

  • "至少"

  • "需要"

fallback_ip

字符串

指定系统在无法使用其池之一时将请求定向到的服务器的 IPv4 或 IPv6 地址。请注意，只有在选择 fallback_ip 负载均衡方法时，系统才会使用回退 IP。

fallback_lb_method

字符串

如果 preferred_lb_method 和 alternate_lb_method 都未能选择池，则系统尝试使用的负载均衡模式。

选项

  • "轮询"

  • "返回DNS"

  • "比率"

  • "拓扑"

  • "静态持久性"

  • "全局可用性"

  • "虚拟服务器容量"

  • "最少连接"

  • "最低往返时间"

  • "最少跳数"

  • "数据包速率"

  • "CPU"

  • "完成率"

  • "服务质量"

  • "每秒千字节"

  • "丢弃数据包"

  • "回退IP"

  • "虚拟服务器评分"

  • "无"

max_answers_returned

整数

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

最大值为 500。

members

列表 / 元素=字典

要分配到池的成员。

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

server

字符串 / 必需

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

virtual_server

字符串 / 必需

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

monitors

列表 / 元素=字符串

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

当availability_requirements.type 为 require 时，monitors 列表中只能包含单个监控器。

名称

字符串 / 必需

GTM 池的名称。

分区

字符串

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

默认值： "Common"

首选负载均衡方法

字符串

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

选项

  • "轮询"

  • "返回DNS"

  • "比率"

  • "拓扑"

  • "静态持久性"

  • "全局可用性"

  • "虚拟服务器容量"

  • "最少连接"

  • "最低往返时间"

  • "最少跳数"

  • "数据包速率"

  • "CPU"

  • "完成率"

  • "服务质量"

  • "每秒千字节"

  • "丢弃数据包"

  • "回退IP"

  • "虚拟服务器评分"

提供程序

字典

f5networks.f5_modules 1.0.0版本中添加

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

身份验证提供程序

字符串

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

此选项在使用 BIG-IQ 设备时才会用到。

no_f5_teem

布尔值

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

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

先前使用的变量F5_TEEM已弃用，因为其名称容易混淆。

选项

  • false ← (默认)

  • true

密码

别名：pass，pwd

字符串 / 必需

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

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

server

字符串 / 必需

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

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

服务器端口

整数

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 网络设备的更多信息，请参见 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"]

首选负载均衡方法

字符串

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

返回：已更改

示例： "topology"

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)