hetzner.hcloud.load_balancer 模块 – 在 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

hetzner.hcloud 0.1.0 中的新增功能

概要

  • 在 Hetzner Cloud 上创建、更新和管理云负载均衡器。

别名:hcloud_load_balancer

要求

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

  • python-dateutil >= 2.7.5

  • requests >=2.20

参数

参数

注释

algorithm

字符串

负载均衡器的算法。

选项

  • "round_robin" ← (默认)

  • "least_connections"

api_endpoint

别名:endpoint

字符串

Hetzner Cloud 的 API 端点。

您也可以通过使用 HCLOUD_ENDPOINT 环境变量来设置此选项。

默认: "https://api.hetzner.cloud/v1"

api_token

字符串 / 必需

Hetzner Cloud 的 API 令牌。

您也可以通过使用 HCLOUD_TOKEN 环境变量来设置此选项。

delete_protection

布尔值

保护负载均衡器不被删除。

选项

  • false

  • true

disable_public_interface

布尔值

禁用公共接口。

选项

  • false ← (默认)

  • true

id

整数

要管理的 Hetzner Cloud 负载均衡器的 ID。

仅当未给出负载均衡器名称时才需要

labels

字典

用户定义的标签(键值对)。

load_balancer_type

字符串

要管理的 Hetzner Cloud 负载均衡器的负载均衡器类型。

如果负载均衡器不存在,则为必需。

location

字符串

负载均衡器的位置。

如果没有给出 network_zone 且负载均衡器不存在,则为必需。

name

字符串

要管理的 Hetzner Cloud 负载均衡器的名称。

仅当未给出负载均衡器 id 或负载均衡器不存在时才需要。

network_zone

字符串

负载均衡器的网络区域。

如果没有给出 location 且负载均衡器不存在,则为必需。

state

字符串

负载均衡器的状态。

选项

  • "absent"

  • "present" ← (默认)

另请参阅

另请参阅

Hetzner Cloud API 的文档

Hetzner Cloud API 的完整参考。

示例

- name: Create a basic Load Balancer
  hetzner.hcloud.load_balancer:
    name: my-Load Balancer
    load_balancer_type: lb11
    algorithm: round_robin
    location: fsn1
    state: present

- name: Ensure the Load Balancer is absent (remove if needed)
  hetzner.hcloud.load_balancer:
    name: my-Load Balancer
    state: absent

返回值

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

描述

hcloud_load_balancer

复杂

负载均衡器实例

返回值: 始终

algorithm

字符串

负载均衡器的算法。

返回值: 始终

只能返回

  • "round_robin"

  • "least_connections"

示例: "round_robin"

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"

作者

  • Lukas Kaemmerling (@LKaemmerling)