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。

要在剧本中使用它，请指定：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`（包含）。
ha_group 字符串	指定要与流量组关联的已配置 `HA group`。在设备上创建 HA 组并将 HA 组与流量组关联后，必须在设备组中的每个设备上创建 HA 组并将其与同一流量组关联。要禁用 HA 组故障转移方法，请为此参数指定空字符串值 (`""`)。禁用 HA 组将使设备恢复使用 `Load Aware` 方法（默认值），除非也配置了 `ha_order` 设置。 `auto_failback` 和 `auto_failback_time` 与 `ha_group` 不兼容。
ha_load_factor 整数	流量组相对于其他流量组向系统呈现的负载值。仅当使用 `Load Aware` 故障转移方法时，此参数才生效。正确的取值范围是 `1 - 1000`（包含）。
ha_order 列表 / 元素=字符串	指定要为故障转移分配设备的顺序。如果配置此设置，则必须在设备组中的每个流量组上配置此设置。值应为属于先前配置的故障转移组的设备的设备名称。将设备作为此参数的参数放置的顺序决定了它们在设备上的 HA 顺序。这意味着更改相同元素的顺序将导致单元发生更改。要禁用 HA 顺序故障转移方法，请为此参数指定空字符串值 (`""`)。禁用 HA 顺序将使设备恢复使用 Load Aware 方法（默认值），除非也配置了 `ha_group` 设置。模块将使用分区作为设备名称的前缀，因此您可以提供完整的路径格式名称 `/Common/bigip1` 或仅名称字符串 `bigip1`。
mac_address 字符串	指定与为流量组定义的浮动 IP 地址关联的浮动媒体访问控制 (MAC) 地址。主要的是，MAC 伪装地址最大限度地减少了由于故障转移导致的 ARP 通信或数据包丢失。 MAC 伪装地址可确保任何目标为特定流量组的流量在故障转移后到达可用的设备，这是因为 MAC 伪装地址会随着流量组一起浮动到可用的设备。如果没有 MAC 伪装地址，发送主机必须通过发送 ARP 请求或依靠来自新活动设备的 gratuitous ARP 来学习新活动设备的 MAC 地址。要取消设置 MAC 地址，请为此参数指定空值 (`""`)。
name 字符串 / 必需	流量组的名称。
partition 字符串	要在其上管理资源的设备分区。默认值： `"Common"`
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。此选项在使用 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"`

注释 

注意

有关使用Ansible管理F5网络设备的更多信息，请参见 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

返回值 

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

Key	描述
auto_failback 布尔值	指定流量组是否回退到ha_order中指定的初始设备。返回：changed 示例：`true`
auto_failback_time 整数	指定系统在回退之前延迟的秒数。返回：changed 示例：`60`
ha_group 字符串	与流量组关联的已配置HA组。返回：changed 示例：`"foo_HA_grp"`
ha_load_factor 整数	流量组相对于其他流量组向系统呈现的负载值。返回：changed 示例：`20`
ha_order 列表 / 元素=字符串	指定设备故障转移的顺序。返回：changed 示例：`["/Common/bigip1", "/Common/bigip2"]`
mac_address 字符串	MAC伪装地址返回：changed 示例：`"02:01:d7:93:35:08"`

作者

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