hetzner.hcloud.hcloud_load_balancer_type_info – Gather infos about the Hetzner Cloud Load Balancer types.
Note
This plugin is part of the hetzner.hcloud collection (version 1.6.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.
To use it in a playbook, specify: hetzner.hcloud.hcloud_load_balancer_type_info.
New in version 0.1.0: of hetzner.hcloud
Synopsis
- Gather infos about your Hetzner Cloud Load Balancer types.
Requirements
The below requirements are needed on the host that executes this module.
- hcloud-python >= 1.0.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_token
string / required
|
This is the API Token for the Hetzner Cloud.
|
|
| endpoint
string
|
Default:
"https://api.hetzner.cloud/v1"
|
This is the API Endpoint for the Hetzner Cloud.
|
| id
integer
|
The ID of the Load Balancer type you want to get.
|
|
| name
string
|
The name of the Load Balancer type you want to get.
|
See Also
See also
- Documentation for Hetzner Cloud API
-
Complete reference for the Hetzner Cloud API.
Examples
- name: Gather hcloud Load Balancer type infos
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 | Returned | Description | |
|---|---|---|---|
| hcloud_load_balancer_type_info
complex
|
always |
The Load Balancer type infos as list
|
|
| description
string
|
always |
Description of the Load Balancer type
Sample:
LB11
|
|
| id
integer
|
always |
Numeric identifier of the Load Balancer type
Sample:
1937415
|
|
| max_assigned_certificates
integer
|
always |
Number of SSL Certificates that can be assigned to a single Load Balancer
Sample:
5
|
|
| max_connections
integer
|
always |
Number of maximum simultaneous open connections
Sample:
1
|
|
| max_services
integer
|
always |
Number of services a Load Balancer of this type can have
Sample:
1
|
|
| max_targets
integer
|
always |
Number of targets a single Load Balancer can have
Sample:
25
|
|
| name
string
|
always |
Name of the Load Balancer type
Sample:
lb11
|
|
Authors
- Lukas Kaemmerling (@LKaemmerling)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hetzner/hcloud/hcloud_load_balancer_type_info_module.html