fortinet.fortios.fortios_system_link_monitor module – Configure Link Health Monitor in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_system_link_monitor
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure Link Health Monitor. |
|
Address mode (IPv4 or IPv6). Choices:
|
|
Traffic class ID. Source firewall.traffic-class.class-id. |
|
Differentiated services code point (DSCP) in the IP header of the probe packet. |
|
Threshold weight to trigger link failure alert. |
|
Number of retry attempts before the server is considered down (1 - 3600). |
|
Gateway IP address used to probe the server. |
|
Gateway IPv6 address used to probe the server. |
|
HA election priority (1 - 50). |
|
String in the http-agent field in the HTTP header. |
|
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. |
|
String that you expect to see in the HTTP-GET requests of the traffic to be monitored. |
|
Detection interval in milliseconds (20 - 3600 * 1000 msec). |
|
Link monitor name. |
|
Packet size of a TWAMP test session (124/158 - 1024). |
|
TWAMP controller password in authentication mode. |
|
Port number of the traffic to be used to monitor the server. |
|
Number of most recent probes that should be used to calculate latency and jitter (5 - 30). |
|
Time to wait before a probe packet is considered lost (20 - 5000 msec). |
|
Protocols used to monitor the server. Choices:
|
|
Number of successful responses received before server is considered recovered (1 - 3600). |
|
Subnet to monitor. |
|
IP and netmask (x.x.x.x/y). |
|
Twamp controller security mode. Choices:
|
|
IP address of the server(s) to be monitored. |
|
Server address. |
|
Mode of server configuration. Choices:
|
|
Servers for link-monitor to monitor. |
|
IP address of the server to be monitored. |
|
Server ID. see <a href=’#notes’>Notes</a>. |
|
Port number of the traffic to be used to monitor the server. |
|
Protocols used to monitor the server. Choices:
|
|
Weight of the monitor to this dst (0 - 255). |
|
Server type (static or dynamic). Choices:
|
|
Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. Choices:
|
|
Source IP address used in packet to the server. |
|
Source IPv6 address used in packet to the server. |
|
Interface that receives the traffic to be monitored. Source system.interface.name. |
|
Enable/disable this link monitor. Choices:
|
|
Enable/disable update cascade interface. Choices:
|
|
Enable/disable updating the policy route. Choices:
|
|
Enable/disable updating the static route. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure Link Health Monitor.
fortinet.fortios.fortios_system_link_monitor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_link_monitor:
addr_mode: "ipv4"
class_id: "0"
diffservcode: "<your_own_value>"
fail_weight: "0"
failtime: "5"
gateway_ip: "<your_own_value>"
gateway_ip6: "<your_own_value>"
ha_priority: "1"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "500"
name: "default_name_15"
packet_size: "124"
password: "<your_own_value>"
port: "0"
probe_count: "30"
probe_timeout: "500"
protocol: "ping"
recoverytime: "5"
route:
-
subnet: "<your_own_value>"
security_mode: "none"
server:
-
address: "<your_own_value>"
server_config: "default"
server_list:
-
dst: "<your_own_value>"
id: "31"
port: "0"
protocol: "ping"
weight: "0"
server_type: "static"
service_detection: "enable"
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_policy_route: "enable"
update_static_route: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |