f5networks.f5_modules.bigip_gtm_server 模块 – 管理 F5 BIG-IP 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_server。

f5networks.f5_modules 1.0.0 中的新功能

概要

• 管理 BIG-IP GTM（现在是 BIG-IP DNS）服务器配置。此模块能够操作 BIG-IP 中的服务器定义。

参数

参数	注释
availability_requirements 字典	如果您激活了多个运行状况监视器，则指定为了使链接被视为可用，必须收到成功响应的运行状况监视器数量。
at_least 整数	指定在将链接视为启动之前，必须成功的最小活动运行状况监视器数量。 此参数仅在使用了 type 为 at_least 时相关。 如果使用了 all 或 require 的类型，则将忽略此参数。
number_of_probers 整数	指定运行探测时应使用的探测器数量。 创建新虚拟服务器时，如果指定了此参数，则还必须指定 number_of_probes 参数。 此参数的值应始终 高于 或 等于 number_of_probers 的值。 此参数仅在使用了 type 为 require 时相关。 如果使用了 all 或 at_least 的类型，则将忽略此参数。
number_of_probes 整数	指定要将此服务器声明为启动，必须成功的最小探测数量。 创建新虚拟服务器时，如果指定了此参数，则还必须指定 number_of_probers 参数。 此参数的值应始终 低于 或 等于 number_of_probers 的值。 此参数仅在使用了 type 为 require 时相关。 如果使用了 all 或 at_least 的类型，则将忽略此参数。
type 字符串 / 必需	指定 monitors 时的监视器规则类型。 创建新池时，如果未指定此值，则将使用默认值 all。 选项 "all" "at_least" "require"
datacenter 字符串	服务器所属的数据中心。创建新的 GTM 服务器时，此值是必需的。
devices 任何	列出每个设备的自 IP 地址和转换。创建新的 GTM 服务器时，此值是必需的。此列表是一个复杂的列表，指定了多个键。 name 键指定设备的名称。每个服务器的设备名称必须唯一。此键是必需的。 address 键包含目标服务器的 IP 地址或 IP 地址列表。此键是必需的。 translation 键包含将上述 address 值转换到的 IP 地址。此键是可选的。 指定重复的 name 字段是提供设备地址的受支持方法。在这种情况下，地址将分配给 name 的地址列表。
iquery_options 字典	指定 Global Traffic Manager 是否使用此 BIG-IP 系统来执行各种探测，然后再将流量委派给它。
allow_path 布尔值	指定系统验证数据中心服务器和本地 DNS 服务器之间的逻辑网络路由。 选项 false true
allow_service_check 布尔值	指定系统通过使用外部服务检查器程序远程运行应用程序，来验证服务器上的应用程序是否正在运行。 选项 false true
allow_snmp 布尔值	指定系统检查运行 SNMP 代理的服务器的性能。 选项 false true
limits 字典	指定池成员级别的资源阈值或限制要求。 当您启用一个或多个限制设置时，系统随后会使用该数据来将成员移入和移出服务。 您可以为任何或所有限制设置定义限制。但是，当成员不满足资源阈值限制要求时，系统会将该成员标记为不可用，并将负载平衡流量定向到另一个资源。
bits_enabled 布尔值	是否启用了比特限制。 此参数允许您打开或关闭限制的效果。 选项 false true
bits_limit 整数	指定成员的最大允许数据吞吐率，单位为比特每秒。 如果网络流量超过此限制，则系统会将该成员标记为不可用。
connections_enabled 布尔值	是否启用了当前连接限制。 此参数允许您打开或关闭限制的效果。 选项 false true
connections_limit 整数	指定所有成员的并发连接总数的最大值。 如果连接数超过此限制，则系统会将服务器标记为不可用。
cpu_enabled 布尔值	是否启用了 CPU 限制。 此参数允许您打开或关闭限制的效果。 选项 false true
cpu_limit 整数	指定 CPU 使用率的百分比。 如果 CPU 使用率百分比高于限制，则系统会将服务器标记为不可用。
memory_enabled 布尔值	是否启用了内存限制。 此参数允许您打开或关闭限制的效果。 选项 false true
memory_limit 整数	指定服务器上虚拟服务器所需的可用内存。 如果可用内存低于此限制，则系统会将服务器标记为不可用。
packets_enabled 布尔值	是否启用了数据包限制。 此参数允许您打开或关闭限制的效果。 选项 false true
packets_limit 整数	指定成员的最大允许数据传输速率，单位为每秒数据包。 如果网络流量超过此限制，则系统会将该成员标记为不可用。
link_discovery 字符串	指定系统是否自动发现此服务器的链接。创建新的 GTM 服务器时，如果未指定此参数，则使用默认值 disabled。 如果您将此参数设置为 enabled 或 enabled-no-delete，还必须确保 virtual_server_discovery 参数也设置为 enabled 或 enabled-no-delete。 选项 "enabled" "已禁用" "已启用-不可删除"
监视器 列表 / 元素=字符串	指定系统当前用于监视此资源的运行状况监视器。 当 availability_requirements.type 为 require 时，monitors 列表中只能有一个监视器。
名称 字符串 / 必需	服务器的名称。 如果虚拟服务器是从 LTM 自动发现的，则从模块引用时，分区名称需要作为虚拟服务器名称的一部分，例如“/Common/vsname”。
分区 字符串	用于管理资源的设备分区。 默认值： "Common"
探针回退 字符串	指定当首选探针不可用时，用于监视此服务器资源的探针类型。 在 TMOS 版本 12.x 中，此选项将被忽略。 从 TMOS 版本 13.x 及更高版本开始，当 prober_preference 设置为 pool 时，必须指定 prober_pool 参数。 这些选项与 prober_preference 参数互斥，但 any-available 或 none 选项除外。 选项 "任意" "数据中心内部" "数据中心外部" "继承" "池" "无"
探针池 字符串	指定用于监视此服务器资源的探针池的名称。 在 TMOS 版本 13.x 及更高版本中，当 prober_preference 设置为 pool 时，此参数是必需的。 名称的格式可以是前面带有分区（/Common/foo），也可以仅指定为对象名称（foo）。 在 TMOS 版本 12.x 中，可以将 prober_pool 设置为空字符串，以恢复为 inherit 的默认设置。
探针首选项 字符串	指定用于监视此服务器资源的探针类型。 在 TMOS 版本 12.x 中，此选项将被忽略。 从 TMOS 版本 13.x 及更高版本开始，当 prober_preference 设置为 pool 时，必须指定 prober_pool 参数。 选项 "数据中心内部" "数据中心外部" "继承" "池"
提供程序 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
身份验证提供程序 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项主要用于处理 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 ← (默认)
服务器类型 别名：product 字符串	指定服务器类型。服务器类型决定了系统可以从服务器收集的指标。创建新的 GTM 服务器时，将使用默认值 bigip。 选项 "alteon-ace-director" "cisco-css" "cisco-server-load-balancer" "通用主机" "radware-wsd" "windows-nt-4.0" "bigip" "cisco-local-director-v2" "extreme" "通用负载均衡器" "sun-solaris" "cacheflow" "cisco-local-director-v3" "foundry-server-iron" "netapp" "windows-2000-server"
状态 字符串	服务器状态。如果为 absent，模块会尝试删除服务器。只有在虚拟服务器未使用此服务器时，此操作才会成功。present 创建服务器并启用它。如果为 enabled，则在服务器存在时启用它。如果为 disabled，则在需要时创建服务器，并将状态设置为 disabled。 选项 "present" ← (默认) "不存在" "enabled" "已禁用"
虚拟服务器发现 字符串	指定系统是否自动发现此服务器的虚拟服务器。创建新的 GTM 服务器时，如果未指定此参数，则使用默认值 disabled。 选项 "enabled" "已禁用" "已启用-不可删除"

注释

注意

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

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

• F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 的特定配置保留到磁盘，请确保至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用该模块来保存运行配置的信息，请参阅该模块的文档。

示例

- name: Create server "GTM_Server"
  bigip_gtm_server:
    name: GTM_Server
    datacenter: /Common/New York
    server_type: bigip
    link_discovery: disabled
    virtual_server_discovery: disabled
    devices:
      - name: server_1
        address: 1.1.1.1
      - name: server_2
        address: 2.2.2.1
        translation: 192.168.2.1
      - name: server_2
        address: 2.2.2.2
      - name: server_3
        addresses:
          - address: 3.3.3.1
          - address: 3.3.3.2
      - name: server_4
        addresses:
          - address: 4.4.4.1
            translation: 192.168.14.1
          - address: 4.4.4.2
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Create server "GTM_Server" with expanded keys
  bigip_gtm_server:
    server: lb.mydomain.com
    user: admin
    password: secret
    name: GTM_Server
    datacenter: /Common/New York
    server_type: bigip
    link_discovery: disabled
    virtual_server_discovery: disabled
    devices:
      - name: server_1
        address: 1.1.1.1
      - name: server_2
        address: 2.2.2.1
        translation: 192.168.2.1
      - name: server_2
        address: 2.2.2.2
      - name: server_3
        addresses:
          - address: 3.3.3.1
          - address: 3.3.3.2
      - name: server_4
        addresses:
          - address: 4.4.4.1
            translation: 192.168.14.1
          - address: 4.4.4.2
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

键	描述
bits_enabled 布尔值	是否启用了位限制。 已返回： 已更改 示例： true
bits_limit 整数	新的 bits_enabled 限制。 已返回： 已更改 示例： 100
connections_enabled 布尔值	是否启用了连接限制。 已返回： 已更改 示例： true
connections_limit 整数	新的 connections_limit 限制。 已返回： 已更改 示例： 100
datacenter 字符串	服务器所属的新 datacenter。 已返回： 已更改 示例： "datacenter01"
link_discovery 字符串	在远程设备上配置的新 link_discovery。 已返回： 已更改 示例： "enabled"
监视器 列表 / 元素=字符串	资源的新的监视器列表。 已返回： 已更改 示例： ["/Common/monitor1", "/Common/monitor2"]
packets_enabled 布尔值	是否启用了数据包限制。 已返回： 已更改 示例： true
packets_limit 整数	新的 packets_limit 限制。 已返回： 已更改 示例： 100
服务器类型 字符串	新的服务器类型。 已返回： 已更改 示例： "bigip"
虚拟服务器发现 字符串	用于 trap 目标的新 virtual_server_discovery 名称。 已返回： 已更改 示例： "disabled"

作者

• Robert Teller (@r-teller)

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题跟踪器
• 主页
• 存储库（源代码）