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

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.3).

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
firewall_ldbmonitor
dictionary
the top level parameters set
dns-match-ip
string
Response IP expected from DNS server.
dns-protocol
string
    Choices:
  • udp
  • tcp
Select the protocol used by the DNS health check monitor to check the health of the server (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
    Choices:
  • ping
  • tcp
  • http
  • passive-sip
  • https
  • dns
Select the Monitor type used by the health check monitor to check the health of the server (PING | TCP | HTTP).
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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: fortimanager-inventory
  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
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_ldbmonitor:
           http-get: <value of string>
           http-match: <value of string>
           http-max-redirects: <value of integer>
           interval: <value of integer>
           name: <value of string>
           port: <value of integer>
           retry: <value of integer>
           timeout: <value of integer>
           type: <value in [ping, tcp, http, ...]>
           src-ip: <value of string>
           dns-match-ip: <value of string>
           dns-protocol: <value in [udp, tcp]>
           dns-request-domain: <value of string>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)