fortios_firewall_ldb_monitor – Configure server load balancing health monitors in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- firewall_ldb_monitor - Configure server load balancing health monitors. type: dict more...
- dns_match_ip - Response IP expected from DNS server. type: str more...
- dns_protocol - Select the protocol used by the DNS health check monitor to check the health of the server (UDP | TCP). type: str choices: udp, tcp more...
- dns_request_domain - Fully qualified domain name to resolve for the DNS probe. type: str more...
- http_get - URL used to send a GET request to check the health of an HTTP server. type: str more...
- http_match - String to match the value expected in response to an HTTP-GET request. type: str more...
- http_max_redirects - The maximum number of HTTP redirects to be allowed (0 - 5). type: int more...
- interval - Time between health checks (5 - 65535 sec). type: int more...
- name - Monitor name. type: str required: true more...
- port - Service port used to perform the health check. If 0, health check monitor inherits port configured for the server (0 - 65535). type: int more...
- retry - Number health check attempts before the server is considered down (1 - 255). type: int more...
- src_ip - Source IP for ldb-monitor. type: str more...
- timeout - Time to wait to receive response to a health check from a server. Reaching the timeout means the health check failed (1 - 255 sec). type: int more...
- type - Select the Monitor type used by the health check monitor to check the health of the server (PING | TCP | HTTP | HTTPS | DNS). type: str choices: ping, tcp, http, https, dns, passive-sip more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.