hetzner.hcloud.load_balancer_type_info module – Gather infos about the Hetzner Cloud Load Balancer types.

Note

This module is part of the hetzner.hcloud collection (version 7.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hetzner.hcloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hetzner.hcloud.load_balancer_type_info.

New in hetzner.hcloud 0.1.0

Synopsis

  • Gather infos about your Hetzner Cloud Load Balancer types.

Aliases: hcloud_load_balancer_type_info

Requirements

The below requirements are needed on the host that executes this module.

  • python-dateutil >= 2.7.5

  • requests >=2.20

Parameters

Parameter

Comments

api_endpoint

aliases: endpoint

string

The endpoint for the Hetzner Cloud API.

You can also set this option by using the HCLOUD_ENDPOINT environment variable.

Default: "https://api.hetzner.cloud/v1"

api_endpoint_hetzner

string

The endpoint for the Hetzner API.

You can also set this option by using the HETZNER_ENDPOINT environment variable.

Default: "https://api.hetzner.com/v1"

api_token

string / required

The token for the Hetzner Cloud API.

You can also set this option by using the HCLOUD_TOKEN environment variable.

id

integer

The ID of the Load Balancer type you want to get.

The module will fail if the provided ID is invalid.

name

string

The name of the Load Balancer type you want to get.

See Also

See also

Documentation for Hetzner APIs

Complete reference for the Hetzner APIs.

Examples

- name: Gather hcloud Load Balancer type infos
  hetzner.hcloud.load_balancer_type_info:
  register: output

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

hcloud_load_balancer_type_info

list / elements=string

The Load Balancer type infos as list

Returned: always

deprecation

dictionary

Describes if, when & how the resources was deprecated. If this field is set to None the resource is not deprecated. If it has a value, it is considered deprecated.

Returned: when deprecated

announced

string

Date of when the deprecation was announced.

Returned: when deprecated

Sample: "2026-03-09T09:00:00Z"

unavailable_after

string

After the time in this field, the resource will not be available from the general listing endpoint of the resource type, and it can not be used in new resources. For example, if this is an image, you can not create new servers with this image after the mentioned date.

Returned: when deprecated

Sample: "2026-06-09T09:00:00Z"

description

string

Description of the Load Balancer type

Returned: always

Sample: "LB11"

id

integer

Numeric identifier of the Load Balancer type

Returned: always

Sample: 1937415

max_assigned_certificates

integer

Number of SSL Certificates that can be assigned to a single Load Balancer

Returned: always

Sample: 5

max_connections

integer

Number of maximum simultaneous open connections

Returned: always

Sample: 1

max_services

integer

Number of services a Load Balancer of this type can have

Returned: always

Sample: 1

max_targets

integer

Number of targets a single Load Balancer can have

Returned: always

Sample: 25

name

string

Name of the Load Balancer type

Returned: always

Sample: "lb11"

Authors

  • Lukas Kaemmerling (@LKaemmerling)