ansible / ansible.builtin / v2.9.27 / module / fortios_system_link_monitor Configure Link Health Monitor in Fortinet's FortiOS and FortiGate. | "added in version" 2.9 of ansible.builtin" Authors: Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico) preview | supported by communityansible.builtin.fortios_system_link_monitor (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and link_monitor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" tasks: - name: Configure Link Health Monitor. fortios_system_link_monitor: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" state: "present" system_link_monitor: addr_mode: "ipv4" failtime: "4" gateway_ip: "<your_own_value>" gateway_ip6: "<your_own_value>" ha_priority: "7" http_agent: "<your_own_value>" http_get: "<your_own_value>" http_match: "<your_own_value>" interval: "11" name: "default_name_12" packet_size: "13" password: "<your_own_value>" port: "15" protocol: "ping" recoverytime: "17" security_mode: "none" server: - address: "<your_own_value>" source_ip: "84.230.14.43" source_ip6: "<your_own_value>" srcintf: "<your_own_value> (source system.interface.name)" status: "enable" update_cascade_interface: "enable" update_static_route: "enable"
host: description: - FortiOS or FortiGate IP address. required: false type: str vdom: default: root description: - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str https: default: true description: - Indicates if the requests towards FortiGate must use HTTPS protocol. type: bool state: choices: - present - absent description: - Indicates whether to create or remove the object. required: true type: str password: default: '' description: - FortiOS or FortiGate password. type: str username: description: - FortiOS or FortiGate username. required: false type: str ssl_verify: default: true description: - Ensures FortiGate certificate must be verified by a proper CA. type: bool system_link_monitor: default: null description: - Configure Link Health Monitor. suboptions: addr_mode: choices: - ipv4 - ipv6 description: - Address mode (IPv4 or IPv6). type: str failtime: description: - Number of retry attempts before the server is considered down (1 - 10) type: int gateway_ip: description: - Gateway IP address used to probe the server. type: str gateway_ip6: description: - Gateway IPv6 address used to probe the server. type: str ha_priority: description: - HA election priority (1 - 50). type: int http_agent: description: - String in the http-agent field in the HTTP header. type: str http_get: description: - If you are monitoring an HTML server you can send an HTTP-GET request with a custom string. Use this option to define the string. type: str http_match: description: - String that you expect to see in the HTTP-GET requests of the traffic to be monitored. type: str interval: description: - Detection interval (1 - 3600 sec). type: int name: description: - Link monitor name. required: true type: str packet_size: description: - Packet size of a twamp test session, type: int password: description: - Twamp controller password in authentication mode type: str port: description: - Port number of the traffic to be used to monitor the server. type: int protocol: choices: - ping - tcp-echo - udp-echo - http - twamp - ping6 description: - Protocols used to monitor the server. type: str recoverytime: description: - Number of successful responses received before server is considered recovered (1 - 10). type: int security_mode: choices: - none - authentication description: - Twamp controller security mode. type: str server: description: - IP address of the server(s) to be monitored. suboptions: address: description: - Server address. required: true type: str type: list source_ip: description: - Source IP address used in packet to the server. type: str source_ip6: description: - Source IPv6 address used in packet to the server. type: str srcintf: description: - Interface that receives the traffic to be monitored. Source system.interface.name. type: str status: choices: - enable - disable description: - Enable/disable this link monitor. type: str update_cascade_interface: choices: - enable - disable description: - Enable/disable update cascade interface. type: str update_static_route: choices: - enable - disable description: - Enable/disable updating the static route. type: str type: dict
build: description: Build number of the fortigate image returned: always sample: '1547' type: str http_method: description: Last method used to provision the content into FortiGate returned: always sample: PUT type: str http_status: description: Last result given by FortiGate on last operation applied returned: always sample: '200' type: str mkey: description: Master key (id) used in the last call to FortiGate returned: success sample: id type: str name: description: Name of the table used to fulfill the request returned: always sample: urlfilter type: str path: description: Path of the table used to fulfill the request returned: always sample: webfilter type: str revision: description: Internal revision number returned: always sample: 17.0.2.10658 type: str serial: description: Serial number of the unit returned: always sample: FGVMEVYYQT3AB5352 type: str status: description: Indication of the operation's result returned: always sample: success type: str vdom: description: Virtual domain used returned: always sample: root type: str version: description: Version of the FortiGate returned: always sample: v5.6.3 type: str