Network Loadbalancer
network_load_balancer
This is a simple module that supports creating or removing NetworkLoadbalancers. This module has a dependency on ionoscloud >= 6.0.2
Example Syntax
name: Create Network Load Balancer
ionoscloudsdk.ionoscloud.network_load_balancer:
datacenter: ''
name: 'AnsibleAutoTestNLB'
ips:
- 10.12.118.224
listener_lan: ''
target_lan: ''
wait: true
wait_timeout: 2000
register: nlb_response
name: Update Network Load Balancer
ionoscloudsdk.ionoscloud.network_load_balancer:
datacenter: ''
network_load_balancer: ''
name: 'AnsibleAutoTestNLB - UPDATE'
listener_lan: ''
target_lan: ''
wait: true
wait_timeout: 2000
state: update
register: nlb_response_update
name: Remove Network Load Balancer
ionoscloudsdk.ionoscloud.network_load_balancer:
network_load_balancer: ''
datacenter: ''
wait: false
wait_timeout: 2000
state: absent
Returned object
{
"changed": true,
"failed": false,
"action": "create",
"network_load_balancer": {
"entities": null,
"href": "https://api.ionos.com/cloudapi/v6/datacenters/89d7e3e1-a688-4ebd-ab01-8beac27e1f8a/networkloadbalancers/c8fb9d9b-a8ef-4358-a275-c23717aebb51",
"id": "c8fb9d9b-a8ef-4358-a275-c23717aebb51",
"metadata": {
"created_by": "<USER_EMAIL>",
"created_by_user_id": "<USER_ID>",
"created_date": "2023-05-31T13:04:34+00:00",
"etag": "0f37a620e34ca7724e3c53370eddf75e",
"last_modified_by": "<USER_EMAIL>",
"last_modified_by_user_id": "<USER_ID>",
"last_modified_date": "2023-05-31T13:04:34+00:00",
"state": "BUSY"
},
"properties": {
"ips": [
"<IP>"
],
"lb_private_ips": null,
"listener_lan": 1,
"name": "AnsibleAutoTestNLB",
"target_lan": 2
},
"type": "networkloadbalancer"
}
}
For more examples please check out the tests here.
state: present
name: Create Network Load Balancer
ionoscloudsdk.ionoscloud.network_load_balancer:
datacenter: ''
name: 'AnsibleAutoTestNLB'
ips:
- 10.12.118.224
listener_lan: ''
target_lan: ''
wait: true
wait_timeout: 2000
register: nlb_response
Available parameters for state present:
name str
True
The name of the Network Load Balancer.
listener_lan str
True
ID of the listening LAN (inbound).
ips list
False
Collection of the Network Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan must be customer-reserved IPs for public Load Balancers, and private IPs for private Load Balancers.
target_lan str
True
ID of the balanced private target LAN (outbound).
lb_private_ips list
False
Collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.
datacenter str
True
The ID or name of the datacenter.
api_url str
False
The Ionos API base URL.
certificate_fingerprint str
False
The Ionos API certificate fingerprint.
username str
False
The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str
False
The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str
False
The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool
False
Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int
False
How long before wait gives up, in seconds. Default: 600
state str
False
Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']
state: absent
name: Remove Network Load Balancer
ionoscloudsdk.ionoscloud.network_load_balancer:
network_load_balancer: ''
datacenter: ''
wait: false
wait_timeout: 2000
state: absent
Available parameters for state absent:
name str
False
The name of the Network Load Balancer.
datacenter str
True
The ID or name of the datacenter.
network_load_balancer str
True
The ID or name of the Network Loadbalancer.
api_url str
False
The Ionos API base URL.
certificate_fingerprint str
False
The Ionos API certificate fingerprint.
username str
False
The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str
False
The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str
False
The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool
False
Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int
False
How long before wait gives up, in seconds. Default: 600
state str
False
Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']
state: update
name: Update Network Load Balancer
ionoscloudsdk.ionoscloud.network_load_balancer:
datacenter: ''
network_load_balancer: ''
name: 'AnsibleAutoTestNLB - UPDATE'
listener_lan: ''
target_lan: ''
wait: true
wait_timeout: 2000
state: update
register: nlb_response_update
Available parameters for state update:
name str
True
The name of the Network Load Balancer.
listener_lan str
True
ID of the listening LAN (inbound).
ips list
False
Collection of the Network Load Balancer IP addresses. (Inbound and outbound) IPs of the listenerLan must be customer-reserved IPs for public Load Balancers, and private IPs for private Load Balancers.
target_lan str
True
ID of the balanced private target LAN (outbound).
lb_private_ips list
False
Collection of private IP addresses with subnet mask of the Network Load Balancer. IPs must contain a valid subnet mask. If no IP is provided, the system will generate an IP with /24 subnet.
datacenter str
True
The ID or name of the datacenter.
network_load_balancer str
True
The ID or name of the Network Loadbalancer.
api_url str
False
The Ionos API base URL.
certificate_fingerprint str
False
The Ionos API certificate fingerprint.
username str
False
The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str
False
The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str
False
The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool
False
Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int
False
How long before wait gives up, in seconds. Default: 600
state str
False
Indicate desired state of the resource. Default: present Options: ['present', 'absent', 'update']
Last updated