Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_system_link_monitor.
New in version 2.10: of fortinet.fortios
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
| enable_log boolean |
| Enable/Disable logging for task. | ||
| state string / required |
| Indicates whether to create or remove the object. | ||
| system_link_monitor dictionary | Configure Link Health Monitor. | |||
| addr_mode string |
| Address mode (IPv4 or IPv6). | ||
| class_id integer | Traffic class ID. Source firewall.traffic-class.class-id. | |||
| diffservcode string | Differentiated services code point (DSCP) in the IP header of the probe packet. | |||
| failtime integer | Number of retry attempts before the server is considered down (1 - 10) | |||
| gateway_ip string | Gateway IP address used to probe the server. | |||
| gateway_ip6 string | Gateway IPv6 address used to probe the server. | |||
| ha_priority integer | HA election priority (1 - 50). | |||
| http_agent string | String in the http-agent field in the HTTP header. | |||
| http_get string | 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. | |||
| http_match string | String that you expect to see in the HTTP-GET requests of the traffic to be monitored. | |||
| interval integer | Detection interval (1 - 3600 sec). | |||
| name string / required | Link monitor name. | |||
| packet_size integer | Packet size of a twamp test session, | |||
| password string | Twamp controller password in authentication mode | |||
| port integer | Port number of the traffic to be used to monitor the server. | |||
| probe_count integer | Number of most recent probes that should be used to calculate latency and jitter (5 - 30). | |||
| probe_timeout integer | Time to wait before a probe packet is considered lost (500 - 5000 msec). | |||
| protocol list / elements=string |
| Protocols used to monitor the server. | ||
| recoverytime integer | Number of successful responses received before server is considered recovered (1 - 10). | |||
| route list / elements=string | Subnet to monitor. | |||
| subnet string / required | IP and netmask (x.x.x.x/y). | |||
| security_mode string |
| Twamp controller security mode. | ||
| server list / elements=string | IP address of the server(s) to be monitored. | |||
| address string / required | Server address. | |||
| service_detection string |
| Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. | ||
| source_ip string | Source IP address used in packet to the server. | |||
| source_ip6 string | Source IPv6 address used in packet to the server. | |||
| srcintf string | Interface that receives the traffic to be monitored. Source system.interface.name. | |||
| status string |
| Enable/disable this link monitor. | ||
| update_cascade_interface string |
| Enable/disable update cascade interface. | ||
| update_static_route string |
| Enable/disable updating the static route. | ||
| vdom string | Default: "root" | 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. | ||
Note
- 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"
access_token: "<your_own_value>"
system_link_monitor:
addr_mode: "ipv4"
class_id: "4 (source firewall.traffic-class.class-id)"
diffservcode: "<your_own_value>"
failtime: "6"
gateway_ip: "<your_own_value>"
gateway_ip6: "<your_own_value>"
ha_priority: "9"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "13"
name: "default_name_14"
packet_size: "15"
password: "<your_own_value>"
port: "17"
probe_count: "18"
probe_timeout: "19"
protocol: "ping"
recoverytime: "21"
route:
-
subnet: "<your_own_value>"
security_mode: "none"
server:
-
address: "<your_own_value>"
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_static_route: "enable"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build string | always | Build number of the fortigate image Sample: 1547 |
| http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
| http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
| mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
| name string | always | Name of the table used to fulfill the request Sample: urlfilter |
| path string | always | Path of the table used to fulfill the request Sample: webfilter |
| revision string | always | Internal revision number Sample: 17.0.2.10658 |
| serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
| status string | always | Indication of the operation's result Sample: success |
| vdom string | always | Virtual domain used Sample: root |
| version string | always | Version of the FortiGate Sample: v5.6.3 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_link_monitor_module.html