fortios_system_link_monitor – Configure Link Health Monitor in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- 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 more...
- addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6 more...
- class_id - Traffic class ID. Source firewall.traffic-class.class-id. type: int more...
- diffservcode - Differentiated services code point (DSCP) in the IP header of the probe packet. type: str more...
- fail_weight - Threshold weight to trigger link failure alert. type: int more...
- failtime - Number of retry attempts before the server is considered down (1 - 3600). type: int more...
- gateway_ip - Gateway IP address used to probe the server. type: str more...
- gateway_ip6 - Gateway IPv6 address used to probe the server. type: str more...
- ha_priority - HA election priority (1 - 50). type: int more...
- http_agent - String in the http-agent field in the HTTP header. type: str more...
- 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 more...
- http_match - String that you expect to see in the HTTP-GET requests of the traffic to be monitored. type: str more...
- interval - Detection interval in milliseconds (20 - 3600 * 1000 msec). type: int more...
- name - Link monitor name. type: str required: true more...
- packet_size - Packet size of a TWAMP test session (124/158 - 1024). type: int more...
- password - TWAMP controller password in authentication mode. type: str more...
- port - Port number of the traffic to be used to monitor the server. type: int more...
- probe_count - Number of most recent probes that should be used to calculate latency and jitter (5 - 30). type: int more...
- probe_timeout - Time to wait before a probe packet is considered lost (20 - 5000 msec). type: int more...
- protocol - Protocols used to monitor the server. type: list choices: ping, tcp-echo, udp-echo, http, https, twamp, ping6 more...
- recoverytime - Number of successful responses received before server is considered recovered (1 - 3600). type: int more...
- route - Subnet to monitor. type: list member_path: route:subnet more...
- subnet - IP and netmask (x.x.x.x/y). type: str required: true more...
- security_mode - Twamp controller security mode. type: str choices: none, authentication more...
- server - IP address of the server(s) to be monitored. type: list member_path: server:address more...
- address - Server address. type: str required: true more...
- server_config - Mode of server configuration. type: str choices: default, individual more...
- server_list - Servers for link-monitor to monitor. type: list member_path: server_list:id more...
- dst - IP address of the server to be monitored. type: str more...
- id - Server ID. see Notes. type: int required: true more...
- port - Port number of the traffic to be used to monitor the server. type: int more...
- protocol - Protocols used to monitor the server. type: list choices: ping, tcp-echo, udp-echo, http, https, twamp more...
- weight - Weight of the monitor to this dst (0 - 255). type: int more...
- server_type - Server type (static or dynamic). type: str choices: static, dynamic more...
- service_detection - Only use monitor to read quality values. If enabled, static routes and cascade interfaces will not be updated. type: str choices: enable, disable more...
- source_ip - Source IP address used in packet to the server. type: str more...
- source_ip6 - Source IPv6 address used in packet to the server. type: str more...
- srcintf - Interface that receives the traffic to be monitored. Source system.interface.name. type: str more...
- status - Enable/disable this link monitor. type: str choices: enable, disable more...
- update_cascade_interface - Enable/disable update cascade interface. type: str choices: enable, disable more...
- update_policy_route - Enable/disable updating the policy route. type: str choices: enable, disable more...
- update_static_route - Enable/disable updating the static route. type: str choices: enable, disable more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: 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
Status
This module is not guaranteed to have a backwards compatible interface.