f5networks.f5_modules.bigip_device_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_group。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理设备组允许您创建 BIG-IP 设备的高可用性对和集群。此模块的使用应与 bigip_configsync_actions 结合使用，以便在禁用自动同步的情况下同步对或集群中的配置。

参数 

参数	注释
asm_sync 布尔值 f5networks.f5_modules 1.22.0 中新增	指定是否同步设备组成员的 ASM 配置。一个设备只能是单个启用 ASM 的设备组的成员。创建新的设备组时，此选项默认为 `false`。选项 `false` `true`
auto_sync 布尔值	指示配置同步是手动进行还是自动进行。创建新的设备组时，此选项默认为 `false`。选项 `false` `true`
description 字符串	设备组的描述。
full_sync 布尔值	指定系统是否在同步操作期间同步整个配置。当为 `no` 时，系统会根据 `max_incremental_sync_size` 中指定的缓存大小执行增量同步操作。增量配置同步是一种在设备组成员之间同步设备组配置的机制，无需为每次配置更改执行完整的配置加载。为了使此功能正常工作，设备组中的所有设备必须最初都同意配置。这通常需要至少将一个完整的配置加载到每个设备。创建新的设备组时，此选项默认为 `false`。选项 `false` `true`
max_incremental_sync_size 整数	指定增量同步的更改缓存的大小。例如，使用默认值，如果您进行超过 1024 KB 的增量更改，系统将执行完全同步操作。使用增量同步操作可以减少配置更改的每个设备同步/加载时间。只有当 `full_sync` 为 `no` 时，此设置才相关。
name 字符串 / 必需	指定设备组的名称。
network_failover 布尔值	指示故障转移是通过网络进行还是硬连线进行。此参数仅对类型为 `sync-failover` 的有效。选项 `false` `true`
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`
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` ← (默认)
save_on_auto_sync 布尔值	执行自动同步时，指定是否保存配置。当为 `false` 时，仅更改要同步到的设备上的运行配置。创建新的设备组时，此选项默认为 `false`。选项 `false` `true`
state 字符串	当 `state` 为 `present` 时，确保设备组存在。当 `state` 为 `absent` 时，确保设备组被移除。选项 `"present"` ← (默认) `"absent"`
type 字符串	指定组的类型。 `sync-failover` 设备组包含同步其配置数据并在设备不可用时相互故障转移的设备。 “仅同步”设备组没有故障转移功能。创建新的设备组时，此选项默认为`sync-only`。此设置一旦设置便无法更改。选项 `“sync-failover”` `“sync-only”`

备注 

注意

此模块主要用作配置 BIG-IP 设备 HA 对的组件。
需要 BIG-IP >= 12.1.x。
有关使用 Ansible 管理 F5 网络设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 特定配置持久保存到磁盘，请务必包含至少一项使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参阅模块文档，了解保存运行配置的模块正确使用方法。

示例 

- name: Create a sync-only device group
  bigip_device_group:
    name: foo-group
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a sync-only device group with auto-sync enabled
  bigip_device_group:
    name: foo-group
    auto_sync: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a sync-only device group with auto-sync and asm-sync enabled
  bigip_device_group:
    name: foo-group
    auto_sync: true
    asm_sync: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
asm_sync 布尔值	设备组的新的 asm_sync 值。返回：changed 示例：`true`
auto_sync 布尔值	设备组的新的 auto_sync 值。返回：changed 示例：`true`
description 字符串	设备组的新描述。返回：changed 示例：`"this is a device group"`
full_sync 布尔值	设备组的新的 full_sync 值。返回：changed 示例：`false`
max_incremental_sync_size 整数	设备组的新同步大小。返回：changed 示例：`1000`
network_failover 布尔值	网络故障转移是否启用。返回：changed 示例：`true`
save_on_auto_sync 布尔值	设备组的新的 save_on_auto_sync 值。返回：changed 示例：`true`
type 字符串	设备组的新类型。返回：changed 示例：`"sync-failover"`

作者

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