Fortinet white logo
Fortinet white logo

CLI Reference

config hchk

config hchk

Description: Configure measuring latency/loss/jitter.

config hchk
edit <name>
		set protocol [ping | http | dns]
		set interval [1 – 3600]
		set probe-cnt [1 – 10]
		set probe-tm [1 – 10]
		set *probe-target {ipv4-address}
		set port [1 – 65535] *available when protocol is set to http
		set http-get {string} *available when protocol is set to http
		set interface <name1>
		set src-type [none | interface | ip]
		set *stc-iface <name1> *available when src-type is set to interval
		set *src-ip {ipv4-address} *available when src-type is set to ip 
		set filter <name1>, <name2>, …
		unset
		next 
		show
		abort
		end
	delete <name>
	purge
	show
	end
show
end

Sample command:

FX201E5919000057 (hmon) # show
config hmon
    config interface-monitoring
        edit 1
            set interval 30
            set interface wan
            set filter rx-bps rx-bytes rx-dropped rx-packets
        next
    end
    config hchk
        edit 1
            set protocol ping
            set interval 5
            set probe-cnt 1
            set probe-tm 2
            set probe-target 8.8.8.8
            set interface wan
            set src-type interface
            set src-iface wan
            set filter rtt loss
        next
    end
end
Parameter Description Type Size Default
interval Monitoring interval in seconds. integer 1 - 3600 30
interface Interface to be monitored. option - none
Option Description
lan LAN as the outgoing interface.
lo Loopback as the outgoing interface.
lte1 LTE 1 as the outgoing interface.
wan WAN as the outgoing interface.
port4 Port 4 as the outgoing interface.
filter Filter types. option - none
Option Description
tx-bytes Transmitter bytes.
rx-bytes Receiver bytes.
tx-packets Transmitter packets.
rx-packets Receiver packets.
tx-dropped Transmitter dropped bytes.
rx-dropped Receiver dropped bytes.
tx-bps Transmitter bytes per second.
rx-bps Receiver bytes per second.

tx-pps

Transmitter packets per second.

rx-pps

Receiver packets per second.

protocol The protocol to use for status checks. option - ping
Option Description
ping Use PING to test the link with the probe-target.
http Use HTTP-GET to test the link with the probe-target.
dns Use DNS-Query to test the link with the probe-target.
interval Monitoring Interval in seconds. integer 1 - 3600 5

probe-cnt

Number of probes sent within an interval.

integer

1 - 10

1

probe-tm

Timeout for a probe in seconds.

integer

1 - 10

2

interface

The outbound interface of probe packets.

option

-

none

Option Description
lan LAN as the outgoing interface.
lo Loopback as the outgoing interface.
lte1 LTE 1 as the outgoing interface.
wan WAN as the outgoing interface.
port4 Port 4 as the outgoing interface.

src-type

The way to set the source address for probes.

option

-

none

Option Description
none Do not set the source address.
interface Set the source address as the address derived from a specific interface.
ip Set the source address as a specific IP.

filter

Filter type.

option

-

rtt loss

Option Description
rtt Round trip time.
loss Packet loss.

config hchk

config hchk

Description: Configure measuring latency/loss/jitter.

config hchk
edit <name>
		set protocol [ping | http | dns]
		set interval [1 – 3600]
		set probe-cnt [1 – 10]
		set probe-tm [1 – 10]
		set *probe-target {ipv4-address}
		set port [1 – 65535] *available when protocol is set to http
		set http-get {string} *available when protocol is set to http
		set interface <name1>
		set src-type [none | interface | ip]
		set *stc-iface <name1> *available when src-type is set to interval
		set *src-ip {ipv4-address} *available when src-type is set to ip 
		set filter <name1>, <name2>, …
		unset
		next 
		show
		abort
		end
	delete <name>
	purge
	show
	end
show
end

Sample command:

FX201E5919000057 (hmon) # show
config hmon
    config interface-monitoring
        edit 1
            set interval 30
            set interface wan
            set filter rx-bps rx-bytes rx-dropped rx-packets
        next
    end
    config hchk
        edit 1
            set protocol ping
            set interval 5
            set probe-cnt 1
            set probe-tm 2
            set probe-target 8.8.8.8
            set interface wan
            set src-type interface
            set src-iface wan
            set filter rtt loss
        next
    end
end
Parameter Description Type Size Default
interval Monitoring interval in seconds. integer 1 - 3600 30
interface Interface to be monitored. option - none
Option Description
lan LAN as the outgoing interface.
lo Loopback as the outgoing interface.
lte1 LTE 1 as the outgoing interface.
wan WAN as the outgoing interface.
port4 Port 4 as the outgoing interface.
filter Filter types. option - none
Option Description
tx-bytes Transmitter bytes.
rx-bytes Receiver bytes.
tx-packets Transmitter packets.
rx-packets Receiver packets.
tx-dropped Transmitter dropped bytes.
rx-dropped Receiver dropped bytes.
tx-bps Transmitter bytes per second.
rx-bps Receiver bytes per second.

tx-pps

Transmitter packets per second.

rx-pps

Receiver packets per second.

protocol The protocol to use for status checks. option - ping
Option Description
ping Use PING to test the link with the probe-target.
http Use HTTP-GET to test the link with the probe-target.
dns Use DNS-Query to test the link with the probe-target.
interval Monitoring Interval in seconds. integer 1 - 3600 5

probe-cnt

Number of probes sent within an interval.

integer

1 - 10

1

probe-tm

Timeout for a probe in seconds.

integer

1 - 10

2

interface

The outbound interface of probe packets.

option

-

none

Option Description
lan LAN as the outgoing interface.
lo Loopback as the outgoing interface.
lte1 LTE 1 as the outgoing interface.
wan WAN as the outgoing interface.
port4 Port 4 as the outgoing interface.

src-type

The way to set the source address for probes.

option

-

none

Option Description
none Do not set the source address.
interface Set the source address as the address derived from a specific interface.
ip Set the source address as a specific IP.

filter

Filter type.

option

-

rtt loss

Option Description
rtt Round trip time.
loss Packet loss.