fortiswitch_system_link_monitor – Configure Link Health Monitor in Fortinet’s FortiSwitch
Added in version 1.0.0.
Synopsis
This module is able to configure a FortiSwitch 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 v7.0.0
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.16
FortiSwitch Version Compatibility
| Supported Version Ranges | |
| fortiswitch_system_link_monitor | v7.0.0 -> 7.4.3 |
Parameters
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- 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
- addr_mode - Address mode (IPv4 or IPv6). type: str choices: ipv4, ipv6
- failtime - Number of retry attempts before bringing server down. type: int
- gateway_ip - Gateway IP used to PING the server. type: str
- gateway_ip6 - Gateway IPv6 address used to PING the server. type: str
- http_get - HTTP GET URL string. type: str
- http_match - Response value from detected server in http-get. type: str
- interval - Detection interval. 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 to poll. type: int
- protocol - Protocols used to detect the server. type: list choices: arp, ping, ping6
- recoverytime - Number of retry attempts before bringing server up. type: int
- security_mode - Twamp controller security mode. type: str choices: none, authentication
- server - Server address(es). type: list
- address - Server address. type: str
- source_ip - Source IP used in packet to the server. type: str
- source_ip6 - Source IPv6 address used in packet to the server. type: str
- srcintf - Interface where the monitor traffic is sent. type: str
- status - Enable/disable link monitor administrative status. type: str choices: enable, disable
- timeout - Detect request timeout. type: int
- update_cascade_interface - Enable/disable update cascade interface. type: str choices: enable, disable
- update_static_route - Enable/disable update static route. type: str choices: enable, disable
Examples
- name: Configure Link Health Monitor.
fortinet.fortiswitch.fortiswitch_system_link_monitor:
state: "present"
system_link_monitor:
addr_mode: "ipv4"
failtime: "5"
gateway_ip: "<your_own_value>"
gateway_ip6: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "1800"
name: "default_name_10"
packet_size: "512"
password: "<your_own_value>"
port: "32767"
protocol: "arp"
recoverytime: "5"
security_mode: "none"
server:
-
address: "<your_own_value>"
source_ip: "<your_own_value>"
source_ip6: "<your_own_value>"
srcintf: "<your_own_value> (source system.interface.name)"
status: "enable"
timeout: "127"
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 fortiSwitch image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
- http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiSwitch 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
- serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
- status - Indication of the operation's result returned: always type: str sample: success
- version - Version of the FortiSwitch returned: always type: str sample: v7.0.0
Status
This module is not guaranteed to have a backwards compatible interface.