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 字典	指定全局流量管理器是否使用此 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" "disabled" "enabled-no-delete"
monitors 列表 / 元素=字符串	指定系统当前用于监控此资源的健康监控器。 当availability_requirements.type为require时，monitors列表中只能有一个监控器。
name 字符串 / 必需	服务器名称。 如果从LTM自动发现虚拟服务器，则在模块中引用虚拟服务器名称时需要包含分区名称，例如：“/Common/vsname”。
partition 字符串	用于管理资源的设备分区。 默认值："Common"
prober_fallback 字符串	指定首选探测器不可用时，用于监控此服务器资源的探测器类型。 此选项在TMOS版本12.x中被忽略。 从TMOS版本13.x及更高版本开始，当prober_preference设置为pool时，必须指定prober_pool参数。 除了any-available或none选项外，这些选项与prober_preference参数互斥。 选项 "any" "inside-datacenter" "outside-datacenter" "inherit" "pool" "none"
prober_pool 字符串	指定用于监控此服务器资源的探测器池的名称。 在TMOS版本13.x及更高版本中，当prober_preference设置为pool时，此参数是必需的。 名称格式可以以分区开头（/Common/foo），也可以仅指定为对象名称（foo）。 在TMOS版本12.x中，可以将prober_pool设置为空字符串以恢复为inherit的默认设置。
prober_preference 字符串	指定用于监控此服务器资源的探测器类型。 此选项在TMOS版本12.x中被忽略。 从TMOS版本13.x及更高版本开始，当prober_preference设置为pool时，必须指定prober_pool参数。 选项 "inside-datacenter" "outside-datacenter" "inherit" "pool"
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 ← (默认)
server_type 别名：product 字符串	指定服务器类型。服务器类型决定系统可以从服务器收集的指标。创建新的GTM服务器时，使用默认值bigip。 选项 "alteon-ace-director" "cisco-css" "cisco-server-load-balancer" "generic-host" "radware-wsd" "windows-nt-4.0" "bigip" "cisco-local-director-v2" "extreme" "generic-load-balancer" "sun-solaris" "cacheflow" "cisco-local-director-v3" "foundry-server-iron" "netapp" "windows-2000-server"
state 字符串	服务器状态。如果为absent，则模块尝试删除服务器。只有在此服务器未被虚拟服务器使用的情况下，此操作才会成功。present创建服务器并启用它。如果为enabled，则如果服务器存在，则启用它。如果为disabled，则根据需要创建服务器，并将状态设置为disabled。 选项 "present" ← (默认) "absent" "enabled" "disabled"
virtual_server_discovery 字符串	指定系统是否自动发现此服务器的虚拟服务器。创建新的GTM服务器时，如果未指定此参数，则使用默认值disabled。 选项 "enabled" "disabled" "enabled-no-delete"

注释

注意

• 有关使用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

返回值

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

Key	描述
bits_enabled 布尔值	比特限制是否启用。 返回：changed 示例：true
bits_limit 整数	新的bits_enabled限制。 返回：changed 示例：100
connections_enabled 布尔值	连接限制是否启用。 返回：changed 示例：true
connections_limit 整数	新的connections_limit限制。 返回：changed 示例：100
datacenter 字符串	服务器所属的新datacenter。 返回：changed 示例："datacenter01"
link_discovery 字符串	远程设备上配置的新link_discovery。 返回：changed 示例："enabled"
monitors 列表 / 元素=字符串	资源的新监控器列表。 返回：changed 示例：["/Common/monitor1", "/Common/monitor2"]
packets_enabled 布尔值	数据包限制是否启用。 返回：changed 示例：true
packets_limit 整数	新的packets_limit限制。 返回：changed 示例：100
server_type 字符串	服务器的新类型。 返回：changed 示例： "bigip"
virtual_server_discovery 字符串	陷阱目标的新 virtual_server_discovery 名称。 返回：changed 示例： "disabled"

作者

• Robert Teller (@r-teller)

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

收藏链接

• 问题追踪器
• 主页
• 代码库 (源代码)