fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_firewall_ldbmonitor Configure server load balancing health monitors. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_firewall_ldbmonitor (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- name: Example playbook hosts: fortimanagers 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. fortinet.fortimanager.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: fortimanagers gather_facts: false connection: httpapi 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 fortinet.fortimanager.fmgr_fact: facts: selector: "firewall_ldbmonitor" params: adom: "ansible" ldb-monitor: "your_value"
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool firewall_ldbmonitor: description: The top level parameters set. required: false suboptions: dns-match-ip: description: Deprecated, please rename it to dns_match_ip. Response IP expected from DNS server. type: str dns-protocol: choices: - udp - tcp description: Deprecated, please rename it to dns_protocol. Select the protocol used by the DNS health check monitor to check the health... type: str dns-request-domain: description: Deprecated, please rename it to dns_request_domain. Fully qualified domain name to resolve for the DNS probe. type: str http-get: description: Deprecated, please rename it to http_get. URL used to send a GET request to check the health of an HTTP server. type: str http-match: description: Deprecated, please rename it to http_match. String to match the value expected in response to an HTTP-GET request. type: str http-max-redirects: description: Deprecated, please rename it to http_max_redirects. The maximum number of HTTP redirects to be allowed type: int interval: description: Time between health checks type: int name: description: Monitor name. required: true type: str port: description: Service port used to perform the health check. type: int retry: description: Number health check attempts before the server is considered down type: int src-ip: description: Deprecated, please rename it to src_ip. Source IP for ldb-monitor. type: str timeout: description: Time to wait to receive response to a health check from a server. type: int type: choices: - ping - tcp - http - passive-sip - https - dns description: Select the Monitor type used by the health check monitor to check the health of the server type: str type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list