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.1.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.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_ldb_monitor.

New in version 2.0.0: of fortinet.fortios

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.9

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

firewall_ldb_monitor

dictionary

Configure server load balancing health monitors.

dns_match_ip

string

Response IP expected from DNS server.

dns_protocol

string

Select the protocol used by the DNS health check monitor to check the health of the server (UDP | TCP).

Choices:

  • udp

  • tcp

dns_request_domain

string

Fully qualified domain name to resolve for the DNS probe.

http_get

string

URL used to send a GET request to check the health of an HTTP server.

http_match

string

String to match the value expected in response to an HTTP-GET request.

http_max_redirects

integer

The maximum number of HTTP redirects to be allowed (0 - 5).

interval

integer

Time between health checks (5 - 65535 sec).

name

string / required

Monitor name.

port

integer

Service port used to perform the health check. If 0, health check monitor inherits port configured for the server (0 - 65535).

retry

integer

Number health check attempts before the server is considered down (1 - 255).

src_ip

string

Source IP for ldb-monitor.

timeout

integer

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

string

Select the Monitor type used by the health check monitor to check the health of the server (PING | TCP | HTTP | HTTPS | DNS).

Choices:

  • ping

  • tcp

  • http

  • https

  • dns

  • passive-sip

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

state

string / required

Indicates whether to create or remove the object.

Choices:

  • present

  • absent

vdom

string

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: “root”

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure server load balancing health monitors.
    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: "8"
        interval: "9"
        name: "default_name_10"
        port: "11"
        retry: "12"
        src_ip: "<your_own_value>"
        timeout: "14"
        type: "ping"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

build

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)