f5networks.f5_modules.bigip_device_traffic_group 模块 – 管理 BIG-IP 上的流量组

注意

此模块是 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_device_traffic_group

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 支持管理 BIG-IP 上的流量组及其属性。

参数

参数

注释

auto_failback

布尔值

指定流量组是否故障回复到 ha_order 中指定的初始设备。

选择

  • false

  • true

auto_failback_time

整数

指定系统在故障回复到 ha_order 中指定的初始设备之前延迟的秒数。

正确的值范围是 0 - 300(包括 0 和 300)。

ha_group

字符串

指定要与流量组关联的已配置的 HA

在设备上创建 HA 组并将其与流量组关联后,必须在设备组中的每个设备上创建一个 HA 组并将其与同一个流量组关联。

要禁用 HA 组故障转移方法,请为此参数指定一个空字符串值 ("")。

禁用 HA 组会将设备恢复为使用 Load Aware 方法(默认),除非还配置了 ha_order 设置。

auto_failbackauto_failback_timeha_group 不兼容。

ha_load_factor

整数

流量组向系统呈现的相对于其他流量组的负载值。

此参数仅在使用 Load Aware 故障转移方法时生效。

正确的值范围是 1 - 1000(包括 1 和 1000)。

ha_order

列表 / 元素=字符串

指定您希望分配设备以进行故障转移的顺序。

如果配置此设置,则必须在设备组中的每个流量组上配置该设置。

这些值应该是先前配置的故障转移组中的设备的设备名称。

作为此参数的参数放置的设备的顺序决定了它们在设备上的 HA 顺序。这意味着更改相同元素的顺序将导致设备上的更改。

要禁用 HA 顺序故障转移方法,请为此参数指定一个空字符串值 ("")。

禁用 HA 顺序会将设备恢复为使用负载感知方法(默认),除非还配置了 ha_group 设置。

设备名称将由模块预先添加分区,因此您可以提供完整路径格式名称 /Common/bigip1 或仅提供名称字符串 bigip1

mac_address

字符串

指定与为流量组定义的浮动 IP 地址关联的浮动媒体访问控制 (MAC) 地址。

主要地,MAC 伪装地址可以最大限度地减少由于故障转移而导致的 ARP 通信或丢包。

MAC 伪装地址确保任何发往特定流量组的流量在故障转移后到达可用设备,这是因为 MAC 伪装地址会随着流量组一起浮动到可用设备。

如果没有 MAC 伪装地址,则发送主机必须学习新激活设备的 MAC 地址,或者通过发送 ARP 请求,或者依赖于新激活设备的免费 ARP。

要取消设置 MAC 地址,请为此参数指定一个空值 ("")。

name

字符串 / 必需

流量组的名称。

partition

字符串

要在其上管理资源的设备分区。

默认值: "Common"

provider

字典

在 f5networks.f5_modules 1.0.0 中添加

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

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 ← (默认)

状态

字符串

当设置为 present 时,确保流量组存在。

当设置为 absent 时,确保流量组被移除。

选择

  • "present" ← (默认)

  • "absent"

注释

注意

  • 有关使用 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 traffic group
  bigip_device_traffic_group:
    name: foo1
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create a traffic group with ha_group failover
  bigip_device_traffic_group:
    name: foo2
    state: present
    ha_group: foo_HA_grp
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create a traffic group with ha_order failover
  bigip_device_traffic_group:
    name: foo3
    state: present
    ha_order:
      - /Common/bigip1.lab.local
      - /Common/bigip2.lab.local
    auto_failback: true
    auto_failback_time: 40
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Change traffic group ha_order to ha_group
  bigip_device_traffic_group:
    name: foo3
    state: present
    ha_group: foo_HA_grp
    ha_order: ""
    auto_failback: false
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Remove traffic group
  bigip_device_traffic_group:
    name: foo
    state: absent
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

描述

auto_failback

布尔值

指定流量组是否故障恢复到 ha_order 中指定的初始设备。

返回: 已更改

示例: true

auto_failback_time

整数

指定系统在故障恢复之前延迟的秒数。

返回: 已更改

示例: 60

ha_group

字符串

与流量组关联的配置的 HA 组。

返回: 已更改

示例: "foo_HA_grp"

ha_load_factor

整数

流量组向系统呈现的相对于其他流量组的负载值。

返回: 已更改

示例: 20

ha_order

列表 / 元素=字符串

指定设备将进行故障转移的顺序。

返回: 已更改

示例: ["/Common/bigip1", "/Common/bigip2"]

mac_address

字符串

MAC 伪装地址

返回: 已更改

示例: "02:01:d7:93:35:08"

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)