fortinet.fortimanager.fmgr_firewall_ldbmonitor module – Configure server load balancing health monitors.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_ldbmonitor.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

firewall_ldbmonitor

dictionary

the top level parameters set

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, default = 0).

interval

integer

Time between health checks (5 - 65635 sec, default = 10).

name

string

Monitor name.

port

integer

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

retry

integer

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

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 …

type

string

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

Choices:

  • ping

  • tcp

  • http

  • passive-sip

  • https

  • dns

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure server load balancing health monitors.
     fmgr_firewall_ldbmonitor:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_ldbmonitor:
           name: 'ansible-test'
           port: 1
           type: tcp #<value in [ping, tcp, http, ...]>
- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the server load balancing health monitors
     fmgr_fact:
       facts:
           selector: 'firewall_ldbmonitor'
           params:
               adom: 'ansible'
               ldb-monitor: ''

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)