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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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 - Configure server load balancing health monitors. type: dict
- http-get - URL used to send a GET request to check the health of an HTTP server. type: str
- http-match - String to match the value expected in response to an HTTP-GET request. type: str
- http-max-redirects - The maximum number of HTTP redirects to be allowed (0 - 5, default = 0). type: int
- interval - Time between health checks (5 - 65635 sec, default = 10). type: int
- name - Monitor name. type: str
- port - Service port used to perform the health check. type: int
- retry - Number health check attempts before the server is considered down (1 - 255, default = 3). type: int
- timeout - Time to wait to receive response to a health check from a server. type: int
- 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]
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, ...]>
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