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

要在剧本中使用它，请指定：f5networks.f5_modules.bigip_gtm_virtual_server。

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 F5 BIG-IP GTM（现在是 BIG-IP DNS）虚拟服务器。一个 GTM 服务器可以有许多与之关联的虚拟服务器。它们的排列方式与池成员之于池的方式非常相似。

参数

参数

注释

address

字符串

指定虚拟服务器的 IP 地址。

创建新的 GTM 虚拟服务器时，此参数是必需的。

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"

limits

字典

指定服务器级别的资源阈值或限制要求。

当您启用一个或多个限制设置时，系统会使用该数据将服务器置于服务中或将其从服务中取出。

您可以为任何或所有限制设置定义限制。但是，当服务器不满足资源阈值限制要求时，系统会将整个服务器标记为不可用，并将负载平衡流量定向到另一个资源。

可用的限制设置取决于服务器的类型。

bits_enabled

布尔值

是否启用位限制。

此参数允许您打开或关闭限制的效果。

选择

  • false

  • true

bits_limit

整数

指定服务器上虚拟服务器的最大允许数据吞吐率，以每秒比特数计。

如果网络流量超出此限制，系统会将服务器标记为不可用。

connections_enabled

布尔值

是否启用当前连接限制。

此参数允许您打开或关闭限制的效果。

选择

  • false

  • true

connections_limit

整数

指定服务器上所有虚拟服务器的并发连接的最大数量（总和）。

如果连接数超出此限制，系统会将服务器标记为不可用。

packets_enabled

布尔值

是否启用数据包限制。

此参数允许您打开或关闭限制的效果。

选择

  • false

  • true

packets_limit

整数

指定服务器上虚拟服务器的最大允许数据传输速率，以每秒数据包数计。

如果网络流量超出此限制，系统会将服务器标记为不可用。

字符串

指定要分配给服务器或虚拟服务器的链路。

monitors

列表 / elements=string

指定系统当前用于监视此资源的运行状况监视器。

当 availability_requirements.type 为 require 时，您的 monitors 列表中只能有一个监视器。

name

字符串 / 必需

指定虚拟服务器的名称。

partition

字符串

要在其上管理资源的设备分区。

默认值： "Common"

port

整数

指定虚拟服务器或池成员的服务端口号。例如，HTTP 服务通常是端口 80。

要指定所有端口，请使用 *。

创建新的 GTM 虚拟服务器时，如果未指定此参数，将使用默认值 *。

provider

字典

在 f5networks.f5_modules 1.0.0 中添加

包含连接详细信息的 dict 对象。

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_name

字符串 / 必需

指定虚拟服务器关联的服务器名称。

state

字符串

当为 present 时，确保资源存在。

当为 absent 时，确保资源被移除。

选择

  • "present" ← (默认)

  • "absent"

  • "enabled"

  • "disabled"

translation_address

字符串

指定虚拟服务器的转换 IP 地址。

要取消设置此参数，请使用空字符串 ("") 作为值。

创建新的 GTM 虚拟服务器时，如果未指定此参数，将使用默认值 ::。

translation_port

字符串

指定虚拟服务器的转换端口号或服务名称。

要指定所有端口，请使用 *。

创建新的 GTM 虚拟服务器时，如果未指定此参数，将使用默认值 *。

virtual_server_dependencies

列表 / 元素=字典

指定当前虚拟服务器所依赖的虚拟服务器。

如果任何指定的服务器不可用，则当前虚拟服务器也会被列为不可用。

server

字符串 / 必需

依赖虚拟服务器所属的服务器。

virtual_server

字符串 / 必需

要依赖的虚拟服务器。

注意

注意

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

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

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

示例

- name: Enable virtual server
  bigip_gtm_virtual_server:
    server_name: server1
    name: my-virtual-server
    state: enabled
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

键

描述

address

字符串

资源的新地址。

返回: changed

示例: "1.2.3.4"

availability_requirements

字典

资源的新可用性要求配置。

返回: changed

示例: {"type": "all"}

limits

字典

资源的新限制配置。

返回: changed

示例: {"bits_enabled": true, "bits_limit": 100}

字符串

资源的新链接值。

返回: changed

示例: "/Common/my-link"

monitors

列表 / elements=string

资源的新监视器列表。

返回: changed

示例: ["/Common/monitor1", "/Common/monitor2"]

port

整数

资源的新端口。

返回: changed

示例: 500

server_name

字符串

与虚拟服务器关联的服务器名称。

返回: changed

示例: "/Common/my-gtm-server"

translation_address

整数

资源的新转换地址。

返回: changed

示例: 500

translation_port

整数

资源的新转换端口。

返回: changed

示例: 500

virtual_server_dependencies

列表 / elements=string

资源的新虚拟服务器依赖项列表。

返回: changed

示例: ["/Common/vs1", "/Common/vs2"]

作者

  • Tim Rupp (@caphrim007)

  • Wojciech Wypior (@wojtek0806)