hetzner.hcloud.hcloud_load_balancer_network – Manage the relationship between Hetzner Cloud Networks and Load Balancers
Note
This plugin is part of the hetzner.hcloud collection (version 1.2.1).
To install it use: ansible-galaxy collection install hetzner.hcloud.
To use it in a playbook, specify: hetzner.hcloud.hcloud_load_balancer_network.
New in version 0.1.0: of hetzner.hcloud
Synopsis
- Create and delete the relationship Hetzner Cloud Networks and Load Balancers
 
Requirements
The below requirements are needed on the host that executes this module.
- hcloud-python >= 1.0.0
 - hcloud-python >= 1.8.1
 
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.   |  
|   ip    string    |    The IP the Load Balancer should have.   |  |
|   load_balancer    string / required    |    The name of the Hetzner Cloud Load Balancer.   |  |
|   network    string / required    |    The name of the Hetzner Cloud Networks.   |  |
|   state    string    |   
  |    State of the load_balancer_network.   |  
See Also
See also
- Documentation for Hetzner Cloud API
 - 
Complete reference for the Hetzner Cloud API.
 
Examples
- name: Create a basic Load Balancer network
  hcloud_load_balancer_network:
    network: my-network
    load_balancer: my-LoadBalancer
    state: present
- name: Create a Load Balancer network and specify the ip address
  hcloud_load_balancer_network:
    network: my-network
    load_balancer: my-LoadBalancer
    ip: 10.0.0.1
    state: present
- name: Ensure the Load Balancer network is absent (remove if needed)
  hcloud_load_balancer_network:
    network: my-network
    load_balancer: my-LoadBalancer
    state: absent
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
|   hcloud_load_balancer_network    complex    |  always |   The relationship between a Load Balancer and a network   |  |
|   ip    string    |  always |   IP of the Load Balancer within the Network ip range  Sample:  10.0.0.8   |  |
|   load_balancer    string    |  always |   Name of the Load Balancer  Sample:  my-LoadBalancer   |  |
|   network    string    |  always |   Name of the Network  Sample:  my-network   |  |
Authors
- Lukas Kaemmerling (@lkaemmerling)
 
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.10/collections/hetzner/hcloud/hcloud_load_balancer_network_module.html