f5networks.f5_modules.bigip_gtm_global 模块 – 管理全局 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_global。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理全局 BIG-IP GTM（现在为 BIG-IP DNS）设置。这些设置包括常规设置、负载均衡设置和与指标相关的设置。

参数 

参数	注释
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` ← (默认)
synchronization 布尔值	指定此系统是否是同步组的成员。启用同步后，系统会定期查询同步组中的其他系统，以获取和分发配置和指标收集更新。同步组可能包含配置为全局流量管理器 (DNS) 和链路控制器系统的系统。选项 `false` `true`
synchronization_group_name 字符串	指定系统所属的同步组的名称。
synchronize_zone_files 布尔值	指定系统是否在同步组成员之间同步域名系统 (DNS) 区域文件。选项 `false` `true`

备注 

注意

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

示例 

- name: Configure synchronization settings
  bigip_gtm_global:
    synchronization: true
    synchronization_group_name: my-group
    synchronize_zone_files: true
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值 

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

键	描述
synchronization 布尔值	系统的同步设置。返回：changed 示例： `true`
synchronization_group_name 字符串	同步组名称。返回：changed 示例： `"my-group"`
synchronize_zone_files 字符串	系统是否同步区域文件。返回：changed 示例： `"my-group"`

作者

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