Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.2.1
Copy Link

Configure Link Health Monitor.

  config system link-monitor
      Description: Configure Link Health Monitor.
      edit <name>
          set addr-mode [ipv4|ipv6]
          set srcintf {string}
          set server <address1>, <address2>, ...
          set protocol {option1}, {option2}, ...
          set port {integer}
          set gateway-ip {ipv4-address-any}
          set gateway-ip6 {ipv6-address}
          set source-ip {ipv4-address-any}
          set source-ip6 {ipv6-address}
          set http-get {string}
          set http-agent {string}
          set http-match {string}
          set interval {integer}
          set failtime {integer}
          set recoverytime {integer}
          set security-mode [none|authentication]
          set password {password}
          set packet-size {integer}
          set ha-priority {integer}
          set update-cascade-interface [enable|disable]
          set update-static-route [enable|disable]
          set status [enable|disable]
      next
  end

config system link-monitor

Parameter Name Description Type Size
addr-mode Address mode (IPv4 or IPv6).
ipv4: IPv4 mode.
ipv6: IPv6 mode.
option -
srcintf Interface that receives the traffic to be monitored. string Maximum length: 15
server <address> IP address of the server(s) to be monitored.
Server address.
string Maximum length: 79
protocol Protocols used to monitor the server.
ping: PING link monitor.
tcp-echo: TCP echo link monitor.
udp-echo: UDP echo link monitor.
http: HTTP-GET link monitor.
twamp: TWAMP link monitor.
ping6: PING6 link monitor.
option -
port Port number of the traffic to be used to monitor the server. integer Minimum value: 1 Maximum value: 65535
gateway-ip Gateway IP address used to probe the server. ipv4-address-any Not Specified
gateway-ip6 Gateway IPv6 address used to probe the server. ipv6-address Not Specified
source-ip Source IP address used in packet to the server. ipv4-address-any Not Specified
source-ip6 Source IPv6 address used in packet to the server. ipv6-address Not Specified
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. string Maximum length: 1024
http-agent String in the http-agent field in the HTTP header. string Maximum length: 1024
http-match String that you expect to see in the HTTP-GET requests of the traffic to be monitored. string Maximum length: 1024
interval Detection interval in milliseconds (500 - 3600 * 1000 msec, default = 500). integer Minimum value: 500 Maximum value: 3600000
failtime Number of retry attempts before the server is considered down (1 - 10, default = 5) integer Minimum value: 1 Maximum value: 3600
recoverytime Number of successful responses received before server is considered recovered (1 - 10, default = 5). integer Minimum value: 1 Maximum value: 3600
security-mode Twamp controller security mode.
none: Unauthenticated mode.
authentication: Authenticated mode.
option -
password Twamp controller password in authentication mode password Not Specified
packet-size Packet size of a twamp test session, integer Minimum value: 64 Maximum value: 1024
ha-priority HA election priority (1 - 50). integer Minimum value: 1 Maximum value: 50
update-cascade-interface Enable/disable update cascade interface.
enable: Enable update cascade interface.
disable: Disable update cascade interface.
option -
update-static-route Enable/disable updating the static route.
enable: Enable updating the static route.
disable: Disable updating the static route.
option -
status Enable/disable this link monitor.
enable: Enable this link monitor.
disable: Disable this link monitor.
option -

Configure Link Health Monitor.

  config system link-monitor
      Description: Configure Link Health Monitor.
      edit <name>
          set addr-mode [ipv4|ipv6]
          set srcintf {string}
          set server <address1>, <address2>, ...
          set protocol {option1}, {option2}, ...
          set port {integer}
          set gateway-ip {ipv4-address-any}
          set gateway-ip6 {ipv6-address}
          set source-ip {ipv4-address-any}
          set source-ip6 {ipv6-address}
          set http-get {string}
          set http-agent {string}
          set http-match {string}
          set interval {integer}
          set failtime {integer}
          set recoverytime {integer}
          set security-mode [none|authentication]
          set password {password}
          set packet-size {integer}
          set ha-priority {integer}
          set update-cascade-interface [enable|disable]
          set update-static-route [enable|disable]
          set status [enable|disable]
      next
  end

config system link-monitor

Parameter Name Description Type Size
addr-mode Address mode (IPv4 or IPv6).
ipv4: IPv4 mode.
ipv6: IPv6 mode.
option -
srcintf Interface that receives the traffic to be monitored. string Maximum length: 15
server <address> IP address of the server(s) to be monitored.
Server address.
string Maximum length: 79
protocol Protocols used to monitor the server.
ping: PING link monitor.
tcp-echo: TCP echo link monitor.
udp-echo: UDP echo link monitor.
http: HTTP-GET link monitor.
twamp: TWAMP link monitor.
ping6: PING6 link monitor.
option -
port Port number of the traffic to be used to monitor the server. integer Minimum value: 1 Maximum value: 65535
gateway-ip Gateway IP address used to probe the server. ipv4-address-any Not Specified
gateway-ip6 Gateway IPv6 address used to probe the server. ipv6-address Not Specified
source-ip Source IP address used in packet to the server. ipv4-address-any Not Specified
source-ip6 Source IPv6 address used in packet to the server. ipv6-address Not Specified
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. string Maximum length: 1024
http-agent String in the http-agent field in the HTTP header. string Maximum length: 1024
http-match String that you expect to see in the HTTP-GET requests of the traffic to be monitored. string Maximum length: 1024
interval Detection interval in milliseconds (500 - 3600 * 1000 msec, default = 500). integer Minimum value: 500 Maximum value: 3600000
failtime Number of retry attempts before the server is considered down (1 - 10, default = 5) integer Minimum value: 1 Maximum value: 3600
recoverytime Number of successful responses received before server is considered recovered (1 - 10, default = 5). integer Minimum value: 1 Maximum value: 3600
security-mode Twamp controller security mode.
none: Unauthenticated mode.
authentication: Authenticated mode.
option -
password Twamp controller password in authentication mode password Not Specified
packet-size Packet size of a twamp test session, integer Minimum value: 64 Maximum value: 1024
ha-priority HA election priority (1 - 50). integer Minimum value: 1 Maximum value: 50
update-cascade-interface Enable/disable update cascade interface.
enable: Enable update cascade interface.
disable: Disable update cascade interface.
option -
update-static-route Enable/disable updating the static route.
enable: Enable updating the static route.
disable: Disable updating the static route.
option -
status Enable/disable this link monitor.
enable: Enable this link monitor.
disable: Disable this link monitor.
option -