fortinet.fortios.fortios_firewall_ldb_monitor module – Configure server load balancing health monitors in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.7).
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 fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_ldb_monitor
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ldb_monitor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure server load balancing health monitors. |
|
Response IP expected from DNS server. |
|
Select the protocol used by the DNS health check monitor to check the health of the server (UDP | TCP). Choices:
|
|
Fully qualified domain name to resolve for the DNS probe. |
|
URL used to send a GET request to check the health of an HTTP server. |
|
String to match the value expected in response to an HTTP-GET request. |
|
The maximum number of HTTP redirects to be allowed (0 - 5). |
|
Time between health checks (5 - 65535 sec). |
|
Monitor name. |
|
Service port used to perform the health check. If 0, health check monitor inherits port configured for the server (0 - 65535). |
|
Number health check attempts before the server is considered down (1 - 255). |
|
Source IP for ldb-monitor. |
|
Time to wait to receive response to a health check from a server. Reaching the timeout means the health check failed (1 - 255 sec). |
|
Select the Monitor type used by the health check monitor to check the health of the server (PING | TCP | HTTP | HTTPS | DNS). Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure server load balancing health monitors.
fortinet.fortios.fortios_firewall_ldb_monitor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_ldb_monitor:
dns_match_ip: "<your_own_value>"
dns_protocol: "udp"
dns_request_domain: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
http_max_redirects: "0"
interval: "10"
name: "default_name_10"
port: "0"
retry: "3"
src_ip: "<your_own_value>"
timeout: "2"
type: "ping"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |