f5networks.f5_modules.bigip_gtm_pool_member 模块 – 管理 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_member。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 GTM（现在为 BIG-IP DNS）池成员的各种设置。此模块可以调整的设置比 bigip_gtm_pool 模块中可以执行的设置广泛得多。池模块旨在允许您调整池中的成员顺序，而不是成员的各种设置。bigip_gtm_pool_member 模块应用于调整所有其他设置。

参数 

参数	注释
aggregate 别名：members 列表 / 元素=字典	要创建、修改或删除的 GTM 池成员定义列表。使用 `aggregates` 时，如果其中一个聚合定义无效，则聚合运行将失败，并指示其最后遇到的错误。该模块`不会`回滚其在遇到错误之前所做的任何更改。该模块也不会指示在失败之前进行了哪些更改，因此我们强烈建议您在检查模式下运行该模块以进行基本验证，然后再执行模块。
description 字符串	池成员的描述。
limits 字典	指定池成员级别的资源阈值或限制要求。启用一个或多个限制设置后，系统将使用该数据将成员加入和移出服务。您可以为任何或所有限制设置定义限制。但是，当成员不满足资源阈值限制要求时，系统会将成员标记为不可用，并将负载均衡流量导向另一个资源。
bits_enabled 布尔值	位限制是否启用。选项 `false` `true`
bits_limit 整数	指定成员的最大允许数据吞吐率，单位为每秒比特。
connections_enabled 布尔值	当前连接限制是否启用。选项 `false` `true`
connections_limit 整数	指定所有成员的并发连接的最大数量。
packets_enabled 布尔值	数据包限制是否启用。选项 `false` `true`
packets_limit 整数	指定成员的最大允许数据传输速率，单位为每秒数据包。
member_order 整数	指定成员在池中出现的顺序。系统将此数字与涉及优先级池成员的负载均衡方法一起使用，例如 Ratio 负载均衡方法。
monitor 字符串	指定分配给此池成员的监视器。池成员仅支持单个监视器。如果 `gtm_virtual_server` 的 `port` 为 `*`，则此参数的可接受值将受到影响。如果在创建新的池成员时未指定此参数，则将使用 `default` 的默认值。要从池成员中删除监视器，请使用值 `none`。
partition 字符串	要在其上管理资源的设备分区。默认值： `"Common"`
ratio 整数	指定池成员的权重，用于负载均衡。
server_name 字符串	指定包含 `virtual_server` 的 GTM 服务器。
state 字符串	池成员状态。当为 `present` 时，确保创建并启用池成员。当为 `absent` 时，确保从系统中删除池成员。当为 `enabled` 或 `disabled` 时，确保在远程设备上启用或禁用池成员（分别）。选项 `"present"` ← (默认) `"absent"` `"enabled"` `"disabled"`
virtual_server 字符串	指定分配给指定 `server` 的 GTM 虚拟服务器的名称。
description 字符串	池成员的描述。
limits 字典	指定池成员级别的资源阈值或限制要求。启用一个或多个限制设置后，系统将使用该数据将成员加入和移出服务。您可以为任何或所有限制设置定义限制。但是，当成员不满足资源阈值限制要求时，系统会将成员标记为不可用，并将负载均衡流量导向另一个资源。
bits_enabled 布尔值	位限制是否启用。选项 `false` `true`
bits_limit 整数	指定成员的最大允许数据吞吐率，单位为每秒比特。
connections_enabled 布尔值	当前连接限制是否启用。选项 `false` `true`
connections_limit 整数	指定所有成员的并发连接的最大数量。
packets_enabled 布尔值	数据包限制是否启用。选项 `false` `true`
packets_limit 整数	指定成员的最大允许数据传输速率，单位为每秒数据包。
member_order 整数	指定成员在池中出现的顺序。系统将此数字与涉及优先级池成员的负载均衡方法一起使用，例如 Ratio 负载均衡方法。
monitor 字符串	指定分配给此池成员的监视器。池成员仅支持单个监视器。如果 `gtm_virtual_server` 的 `port` 为 `*`，则此参数的可接受值将受到影响。如果在创建新的池成员时未指定此参数，则将使用 `default` 的默认值。要从池成员中删除监视器，请使用值 `none`。
partition 字符串	要在其上管理资源的设备分区。默认值： `"Common"`
pool 字符串 / 必需	GTM 池的名称。对于在不同分区上创建的池，必须以完整路径格式指定池的分区，例如 `/FooBar/pool_name`。
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth provider 以从远程设备获取身份验证令牌。此选项主要用于与 BIG-IQ 设备配合使用。
no_f5_teem 布尔值	如果为 `yes`，则不会将 TEEM 遥测数据发送到 F5。可以通过设置环境变量 `F5_TELEMETRY_OFF` 来省略此选项。之前使用的变量 `F5_TEEM` 已弃用，因为其名称容易引起混淆。选项 `false` ← (默认) `true`
密码别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。可以通过设置环境变量 `F5_PASSWORD` 来省略此选项。
服务器字符串 / 必需	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` ← (默认)
比率整数	指定池成员的权重，用于负载均衡。
replace_all_with 别名：purge 布尔值	删除`aggregate`参数中未定义的成员。此操作是全有或全无的，这意味着如果某些池成员无法删除，它将停止。选项 `false` ← (默认) `true`
服务器名称字符串	指定包含 `virtual_server` 的 GTM 服务器。
状态字符串	池成员状态。当为 `present` 时，确保创建并启用池成员。当为 `absent` 时，确保从系统中删除池成员。当为 `enabled` 或 `disabled` 时，确保在远程设备上启用或禁用池成员（分别）。选项 `"present"` ← (默认) `"absent"` `"enabled"` `"disabled"`
类型字符串 / 必需	成员所在的 GTM 池的类型。选项 `"a"` `"aaaa"` `"cname"` `"mx"` `"naptr"` `"srv"`
虚拟服务器字符串	指定分配给指定 `server` 的 GTM 虚拟服务器的名称。

备注 

注意

有关使用 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 member
  bigip_gtm_pool_member:
    pool: pool1
    server_name: server1
    virtual_server: vs1
    type: a
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a GTM pool member different partition
  bigip_gtm_pool_member:
    server_name: /Common/foo_name
    virtual_server: GTMVSName
    type: a
    pool: /FooBar/foo-pool
    partition: Common
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add GTM pool members aggregate
  bigip_gtm_pool_member:
    pool: pool1
    type: a
    aggregate:
      - server_name: server1
        virtual_server: vs1
        partition: Common
        description: web server1
        member_order: 0
      - server_name: server2
        virtual_server: vs2
        partition: Common
        description: web server2
        member_order: 1
      - server_name: server3
        virtual_server: vs3
        partition: Common
        description: web server3
        member_order: 2
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add GTM pool members aggregate, remove non aggregates
  bigip_gtm_pool_member:
    pool: pool1
    type: a
    aggregate:
      - server_name: server1
        virtual_server: vs1
        partition: Common
        description: web server1
        member_order: 0
      - server_name: server2
        virtual_server: vs2
        partition: Common
        description: web server2
        member_order: 1
      - server_name: server3
        virtual_server: vs3
        partition: Common
        description: web server3
        member_order: 2
    replace_all_with: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值 

公共返回值已记录在此处，以下是此模块独有的字段

键	描述
bits_enabled 布尔值	位限制是否启用。返回：已更改示例： `true`
bits_limit 整数	新的 bits_enabled 限制。返回：已更改示例： `100`
connections_enabled 布尔值	连接限制是否启用。返回：已更改示例： `true`
connections_limit 整数	新的 connections_limit 限制。返回：已更改示例： `100`
description 字符串	成员的新描述。返回：已更改示例： `"My description"`
已禁用布尔值	池成员是否已禁用。返回：已更改示例： `true`
已启用布尔值	池成员是否已启用。返回：已更改示例： `true`
member_order 整数	成员在池中显示的新顺序。返回：已更改示例： `2`
monitor 字符串	分配给池成员的新监控器。返回：已更改示例： `"/Common/monitor1"`
packets_enabled 布尔值	数据包限制是否启用。返回：已更改示例： `true`
packets_limit 整数	新的 packets_limit 限制。返回：已更改示例： `100`
比率整数	成员用于负载均衡的新权重。返回：已更改示例： `10`
replace_all_with 布尔值	从设备中清除所有非聚合池成员返回：已更改示例： `true`

作者

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)