hetzner.hcloud.load_balancer_info 模块 – 收集关于您的 Hetzner Cloud 负载均衡器的信息。

注意

此模块是 hetzner.hcloud 集合（版本 4.2.2）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install hetzner.hcloud。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：hetzner.hcloud.load_balancer_info。

概要

• 收集关于您的 Hetzner Cloud 负载均衡器的信息。

别名：hcloud_load_balancer_info

要求

执行此模块的主机需要满足以下要求。

• python-dateutil >= 2.7.5

• requests >=2.20

参数

参数	注释
api_endpoint 别名：endpoint 字符串	Hetzner Cloud 的 API 端点。 您也可以使用 HCLOUD_ENDPOINT 环境变量设置此选项。 默认值： "https://api.hetzner.cloud/v1"
api_token 字符串 / 必需	Hetzner Cloud 的 API 令牌。 您也可以使用 HCLOUD_TOKEN 环境变量设置此选项。
id 整数	您想要获取的负载均衡器的 ID。 如果提供的 ID 无效，该模块将失败。
label_selector 字符串	您想要获取的负载均衡器的标签选择器。
name 字符串	您想要获取的负载均衡器的名称。

另请参阅

另请参阅

Hetzner Cloud API 的文档

Hetzner Cloud API 的完整参考。

示例

- name: Gather hcloud load_balancer infos
  hetzner.hcloud.load_balancer_info:
  register: output

- name: Print the gathered infos
  debug:
    var: output

返回值

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

键	描述
hcloud_load_balancer_info 复杂	负载均衡器信息列表 返回值： 总是
delete_protection 布尔值	如果负载均衡器受到删除保护，则为 True 返回值： 总是 示例： false
disable_public_interface 布尔值	如果负载均衡器公共接口被禁用，则为 True 返回值： 总是 示例： false
id 整数	负载均衡器的数字标识符 返回值： 总是 示例： 1937415
ipv4_address 字符串	负载均衡器的公共 IPv4 地址 返回值： 总是 示例： "116.203.104.109"
ipv6_address 字符串	负载均衡器的公共 IPv6 地址 返回值： 总是 示例： "2a01:4f8:1c1c:c140::1"
labels 字典	用户定义的标签（键值对） 返回值： 总是
load_balancer_type 字符串	负载均衡器的负载均衡器类型名称 返回值： 总是 示例： "cx22"
location 字符串	负载均衡器位置的名称 返回值： 总是 示例： "fsn1"
name 字符串	负载均衡器的名称 返回值： 总是 示例： "my-Load-Balancer"
services 复杂	来自此负载均衡器的所有服务 返回值： 总是
destination_port 整数	流量转发到的端口，即目标监听和接受连接的端口。 返回值： 总是 示例： 80
health_check 复杂	运行状况检查的配置 返回值： 总是
http 复杂	使用协议 http/https 进行运行状况检查的其他配置 返回值： 总是
domain 字符串	我们将在 HTTP HOST 标头中设置的域 返回值： 总是 示例： "example.com"
path 字符串	我们将尝试访问的路径 返回值： 总是 示例： "/"
response 字符串	我们期望的响应，如果响应不在健康检查响应范围内，则目标为不健康。 返回值： 总是
status_codes 列表 / 元素=字符串	当执行健康检查时，我们期望获得的 HTTP 状态代码列表。 返回值： 总是 示例： ["2??", "3??"]
tls 布尔值	验证 TLS 证书，仅当健康检查协议为 https 时可用。 返回值： 总是 示例： false
interval 整数	健康检查的间隔，以秒为单位。 返回值： 总是 示例： 15
port 整数	执行健康检查的端口。 返回值： 总是 示例： 80
protocol 字符串	执行健康检查的协议。 返回值： 总是 示例： "http"
retries 整数	将目标标记为不健康之前的重试次数。 返回值： 总是 示例： 3
timeout 整数	健康检查的超时时间，以秒为单位。 返回值： 总是 示例： 10
http 复杂	HTTP 和 HTTPS 服务的配置。 返回值： 总是
certificates 列表 / 元素=字符串	证书的名称或 ID 列表。 返回值： 总是
cookie_lifetime 整数	启用粘性会话时设置的 Cookie 的生命周期，以秒为单位。 返回值： 总是 示例： 3600
cookie_name 字符串	启用粘性会话时设置的 Cookie 的名称。 返回值： 总是 示例： "HCLBSTICKY"
redirect_http 布尔值	将端口 80 的流量重定向到端口 443，仅当协议为 https 时可用。 返回值： 总是 示例： false
sticky_sessions 布尔值	启用或禁用粘性会话。 返回值： 总是 示例： true
listen_port 整数	服务监听的端口，即用户可以连接的端口。 返回值： 总是 示例： 443
protocol 字符串	服务的协议。 返回值： 总是 示例： "http"
proxyprotocol 布尔值	启用 PROXY 协议。 返回值： 总是 示例： false
targets 复杂	负载均衡器的目标。 返回值： 总是
health_status 列表 / 元素=字符串	此目标上服务的健康状态列表。仅当目标类型为“server”和“ip”时存在。 返回：如果类型为 server 或 ip。
listen_port 整数	负载均衡器目标监听端口。 返回值： 总是 示例： 80
status 字符串	负载均衡器目标状态。 返回值： 总是 只能返回 “healthy” “unhealthy” “unknown” 示例： "healthy"
ip 字符串	专用服务器的 IP 地址。 返回：如果类型为 ip。 示例： "127.0.0.1"
label_selector 字符串	标签选择器。 返回：如果类型为 label_selector。 示例： "application=backend"
load_balancer 字符串	负载均衡器的名称 返回值： 总是 示例： "my-LoadBalancer"
server 字符串	服务器的名称。 返回：如果类型为 server。 示例： "my-server"
type 字符串	负载均衡器目标的类型。 返回值： 总是 示例： "server"
use_private_ip 布尔值	通过 Hetzner Cloud 网络将流量路由到负载均衡器的私有 IP 地址。 负载均衡器需要连接到网络。请参阅 hetzner.hcloud.load_balancer_network 返回值： 总是 示例： true

作者

• Lukas Kaemmerling (@LKaemmerling)

合集链接

• 问题跟踪器
• 存储库（源代码）
• Hetzner Cloud API 参考
• Hetzner Cloud API 更新日志