> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/ansible/api/network-load-balancer/modules/network_load_balancer_rule.md). # Network Loadbalancer forwarding rule ## network\_load\_balancer\_rule This is a simple module that supports creating or removing NATGateway Flowlog rules. This module has a dependency on ionoscloud >= 6.0.2 ### Example Syntax ```yaml name: Create Network Load Balancer Forwarding Rule ionoscloudsdk.ionoscloud.network_load_balancer_rule: name: 'AnsibleAutoTestNLB' algorithm: ROUND_ROBIN protocol: TCP listener_ip: 10.12.118.224 listener_port: '8081' targets: - ip: 22.231.2.2 port: '8080' weight: '123' health_check: client_timeout: 50 connect_timeout: 5000 target_timeout: 5000 retries: 1 datacenter: '' network_load_balancer: '' wait: true register: nlb_forwarding_rule_response name: Update Network Load Balancer Forwarding Rule ionoscloudsdk.ionoscloud.network_load_balancer_rule: datacenter: '' network_load_balancer: '' forwarding_rule: '' name: 'AnsibleAutoTestNLB - UPDATED' algorithm: ROUND_ROBIN protocol: TCP wait: true state: update register: nlb_forwarding_rule_update_response name: Delete Network Load Balancer Forwarding Rule ionoscloudsdk.ionoscloud.network_load_balancer_rule: datacenter: '' network_load_balancer: '' forwarding_rule: '' state: absent ``` ### Returned object ```json { "changed": true, "failed": false, "action": "create", "forwarding_rule": { "href": "https://api.ionos.com/cloudapi/v6/datacenters/89d7e3e1-a688-4ebd-ab01-8beac27e1f8a/networkloadbalancers/c8fb9d9b-a8ef-4358-a275-c23717aebb51/forwardingrules/6dec4e0c-dd8d-4348-acd1-2d0bf16d00e2", "id": "6dec4e0c-dd8d-4348-acd1-2d0bf16d00e2", "metadata": { "created_by": "", "created_by_user_id": "", "created_date": "2023-05-31T13:08:44+00:00", "etag": "fb2a7f7680346fe0677dc3d76d652be6", "last_modified_by": "", "last_modified_by_user_id": "", "last_modified_date": "2023-05-31T13:08:44+00:00", "state": "BUSY" }, "properties": { "algorithm": "ROUND_ROBIN", "health_check": { "client_timeout": 50, "connect_timeout": 5000, "retries": 1, "target_timeout": 5000 }, "listener_ip": "", "listener_port": 8081, "name": "AnsibleAutoTestNLB", "protocol": "TCP", "targets": [ { "health_check": null, "ip": "", "port": 8080, "weight": 123 } ] }, "type": "forwarding-rule" } } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/networkloadbalancer). ## state: **present** ```yaml name: Create Network Load Balancer Forwarding Rule ionoscloudsdk.ionoscloud.network_load_balancer_rule: name: 'AnsibleAutoTestNLB' algorithm: ROUND_ROBIN protocol: TCP listener_ip: 10.12.118.224 listener_port: '8081' targets: - ip: 22.231.2.2 port: '8080' weight: '123' health_check: client_timeout: 50 connect_timeout: 5000 target_timeout: 5000 retries: 1 datacenter: '' network_load_balancer: '' wait: true register: nlb_forwarding_rule_response ``` #### Available parameters for state **present**:

Name	Required	Description
name str	True	The name of the Network Load Balancer forwarding rule.
algorithm str	True	Balancing algorithm
protocol str	True	Balancing protocol
listener_ip str	True	Listening (inbound) IP.
listener_port str	True	Listening (inbound) port number; valid range is 1 to 65535.
health_check dict	False	Health check properties for Network Load Balancer forwarding rule.
targets list	True	Array of items in the collection.
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: **absent** ```yaml name: Delete Network Load Balancer Forwarding Rule ionoscloudsdk.ionoscloud.network_load_balancer_rule: datacenter: '' network_load_balancer: '' forwarding_rule: '' state: absent ``` #### Available parameters for state **absent**:

Name	Required	Description
name str	False	The name of the Network Load Balancer forwarding rule.
datacenter str	True	The ID or name of the datacenter.
network_load_balancer str	True	The ID or name of the Network Loadbalancer.
forwarding_rule str	True	The ID or name of the Network Loadbalancer forwarding rule.
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** ```yaml name: Update Network Load Balancer Forwarding Rule ionoscloudsdk.ionoscloud.network_load_balancer_rule: datacenter: '' network_load_balancer: '' forwarding_rule: '' name: 'AnsibleAutoTestNLB - UPDATED' algorithm: ROUND_ROBIN protocol: TCP wait: true state: update register: nlb_forwarding_rule_update_response ``` #### Available parameters for state **update**:

Name	Required	Description
name str	False	The name of the Network Load Balancer forwarding rule.
algorithm str	False	Balancing algorithm
protocol str	False	Balancing protocol
listener_ip str	False	Listening (inbound) IP.
listener_port str	False	Listening (inbound) port number; valid range is 1 to 65535.
health_check dict	False	Health check properties for Network Load Balancer forwarding rule.
targets list	False	Array of items in the collection.
datacenter str	True	The ID or name of the datacenter.
network_load_balancer str	True	The ID or name of the Network Loadbalancer.
forwarding_rule str	True	The ID or name of the Network Loadbalancer forwarding rule.
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']

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ionos.com/cloud/ansible/api/network-load-balancer/modules/network_load_balancer_rule.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.