f5networks.f5_modules.bigip_device_ha_group 模块 – 管理 BIG-IP 系统上的 HA 组设置

注意

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

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

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

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

f5networks.f5_modules 1.0.0 中的新功能

概要

• 管理 BIG-IP 系统上的 HA（高可用性）组设置。

参数

参数	注释
active_bonus 整数	指定要添加到活动单元 HA 分数的额外值。 当系统创建 HA 组时，此值由系统设置为 10。
description 字符串	用户创建的 HA 组描述。
enable 布尔值	当设置为 false 时，系统将禁用 HA 分数功能。 选项 false true ← (默认)
name 字符串 / 必需	要创建/管理的 HA 组的名称。
pools 列表 / elements=字典	指定对 HA 分数有贡献的池。 这些池必须存在于 BIG-IP 上，否则操作将失败。
attribute 字符串	对 HA 分数有贡献的池属性。 选项 "percent-up-members" ← (默认)
minimum_threshold 整数	低于此值时，选定的池属性对 HA 分数没有贡献。 此值必须大于池中存在的池成员数。 在 TMOS 12.x 版本中，此属性名为 threshold，但在 13.x 及更高版本中已弃用。 在针对 v12.x 运行的模块中指定此属性将保持与设置 threshold 选项相同的行为。
partition 字符串	指定池所在的设备分区。 如果以完整路径格式指定 pool_name，则忽略此参数。 默认值： "Common"
pool_name 字符串 / 必需	用于对 HA 分数做出贡献的池名称。 引用池可以使用完整路径格式，例如，/Common/pool_name。 当以完整路径格式引用池时，将忽略 partition 参数。
weight 整数 / 必需	选定的池属性对 HA 分数做出贡献的最大值。
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 ← (默认)
state 字符串	当 present 时，确保资源存在。 当 absent 时，确保资源被删除。 选项 "present" ← (默认) "absent"
trunks 列表 / elements=字典	指定对 HA 分数有贡献的链路聚合。 这些链路聚合必须存在于 BIG-IP 上，否则操作将失败。
attribute 字符串	对 HA 分数有贡献的链路聚合属性。 选项 "percent-up-members" ← (默认)
minimum_threshold 整数	低于此值时，选定的链路聚合属性对 HA 分数没有贡献。 此值必须大于链路聚合成员数。 在 TMOS 12.x 版本中，此属性名为 threshold，但在 13.x 及更高版本中已弃用。 在针对 v12.x 运行的模块中指定此属性将保持与设置 threshold 选项相同的行为。
trunk_name 字符串 / 必需	用于对 HA 分数做出贡献的链路聚合名称。
weight 整数 / 必需	选定的链路聚合属性对 HA 分数做出贡献的最大值。

注释

注意

• 此模块不支持原子移除 HA 组对象。

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

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

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

示例

- name: Create HA group no members, not active
  bigip_device_ha_group:
    name: foo_ha
    description: empty_foo
    active_bonus: 20
    enable: false
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create HA group with pools and trunks
  bigip_device_ha_group:
    name: baz_ha
    description: non_empty_baz
    active_bonus: 15
    pools:
      - pool_name: foopool
        weight: 30
        minimum_threshold: 1
    trunks:
      - trunk_name: footrunk
        weight: 70
        minimum_threshold: 2
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create HA group pools using full_path format
  bigip_device_ha_group:
    name: bar_ha
    description: non_empty_bar
    active_bonus: 12
    pools:
      - pool_name: /Baz/foopool
        weight: 30
        minimum_threshold: 1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove HA group
  bigip_device_ha_group:
    name: foo_ha
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
active_bonus 整数	要添加到活动单元的 HA 分数的额外值。 返回: changed 示例: 20
description 字符串	用户创建的 HA 组描述。 返回: changed 示例: "Some Group"
enable 布尔值	启用或禁用 HA 分数功能。 返回: changed 示例: true
name 字符串	HA 组的名称。 返回: changed 示例: "foo_HA"
pools 复杂	将贡献 HA 分数的池。 返回: changed 示例: "hash/dictionary of values"
attribute 字符串	对 HA 分数有贡献的池属性。 返回: changed 示例: "percent-up-members"
minimum_threshold 整数	低于此值，选定的池属性对 HA 分数没有贡献。 返回: changed 示例: 2
partition 字符串	指定池所在的设备分区。 返回: changed 示例: "Common"
pool_name 字符串	用于对 HA 分数做出贡献的池名称。 返回: changed 示例: "foo_pool"
weight 整数	选定的池属性对 HA 分数做出贡献的最大值。 返回: changed 示例: 40
trunks 复杂	将贡献 HA 分数的 trunk。 返回: changed 示例: "hash/dictionary of values"
attribute 字符串	对 HA 分数有贡献的链路聚合属性。 返回: changed 示例: "percent-up-members"
minimum_threshold 整数	低于此值，选定的 trunk 属性对 HA 分数没有贡献。 返回: changed 示例: 2
trunk_name 字符串	用于对 HA 分数做出贡献的链路聚合名称。 返回: changed 示例: "foo_trunk"
weight 整数	选定的链路聚合属性对 HA 分数做出贡献的最大值。 返回: changed 示例: 40

作者

• Wojciech Wypior (@wojtek0806)

集合链接

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