fortios_system_link_monitor – Configure Link Health Monitor in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
Synopsis¶
- 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.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- host - FortiOS or FortiGate IP address. type: str required: False
- username - FortiOS or FortiGate username. type: str required: False
- password - FortiOS or FortiGate password. type: str default:
- vdom - 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 default: root
- https - Indicates if the requests towards FortiGate must use HTTPS protocol. type: bool default: True
- ssl_verify - Ensures FortiGate certificate must be verified by a proper CA. type: bool default: True
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- system_link_monitor - Configure Link Health Monitor. type: dict
- addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
- failtime - Number of retry attempts before the server is considered down (1 - 10) type: int
- gateway_ip - Gateway IP address used to probe the server. type: str
- gateway_ip6 - Gateway IPv6 address used to probe the server. type: str
- ha_priority - HA election priority (1 - 50). type: int
- http_get - 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 - String that you expect to see in the HTTP-GET requests of the traffic to be monitored. type: str
- interval - Detection interval (1 - 3600 sec). type: int
- name - Link monitor name. type: str required: True
- packet_size - Packet size of a twamp test session, type: int
- password - Twamp controller password in authentication mode type: str
- port - Port number of the traffic to be used to monitor the server. type: int
- protocol - Protocols used to monitor the server. type: str choices: ping, tcp-echo, udp-echo, http, twamp, ping6
- recoverytime - Number of successful responses received before server is considered recovered (1 - 10). type: int
- security_mode - Twamp controller security mode. type: str choices: none, authentication
- server - IP address of the server(s) to be monitored. type: list
- address - Server address. type: str required: True
- source_ip - Source IP address used in packet to the server. type: str
- source_ip6 - Source IPv6 address used in packet to the server. type: str
- srcintf - Interface that receives the traffic to be monitored. Source system.interface.name. type: str
- status - Enable/disable this link monitor. type: str choices: enable, disable
- update_cascade_interface - Enable/disable update cascade interface. type: str choices: enable, disable
- update_static_route - Enable/disable updating the static route. type: str choices: enable, disable
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure Link Health Monitor.
fortios_system_link_monitor:
vdom: "{{ vdom }}"
state: "present"
system_link_monitor:
addr_mode: "ipv4"
failtime: "4"
gateway_ip: "<your_own_value>"
gateway_ip6: "<your_own_value>"
ha_priority: "7"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "10"
name: "default_name_11"
packet_size: "12"
password: "<your_own_value>"
port: "14"
protocol: "ping"
recoverytime: "16"
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"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3