fmgr_firewall_ldbmonitor – Configure server load balancing health monitors.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
firewall_ldbmonitor yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • firewall_ldbmonitor - no description type: dict
    • 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, default = 0). type: int more...
    • interval - Time between health checks (5 - 65635 sec, default = 10). type: int more...
    • name - Monitor name. type: str more...
    • port - Service port used to perform the health check. type: int more...
    • retry - Number health check attempts before the server is considered down (1 - 255, default = 3). type: int more...
    • timeout - Time to wait to receive response to a health check from a server. type: int more...
    • type - Select the Monitor type used by the health check monitor to check the health of the server (PING | TCP | HTTP). type: str choices: [ping, tcp, http, passive-sip, https, dns] more...
    • src-ip - Source IP for ldb-monitor. type: str 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...

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: 'your_value'

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.