Fortinet white logo
Fortinet white logo

CLI Reference

config hmon hchk

config hmon hchk

Description: Configure measuring latency/loss/jitter.

config hmon hchk
  edit <name>
    addr-mode [ipv4 | ipv6]
    set protocol [ping | http | dns]
    set interval [1 – 3600]
    set probe-cnt [1 – 10]
    set probe-tm [1 – 10]
    set *probe-target {ipv4-address or FQDN}
    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 | ip6]
    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 *src-ip6 {ipv6-address} *available when src-type is set to ip6
    set filter <name1>, <name2>, …
  next
end

Sample command:

config hmon
    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 port1
            set src-type interface
            set src-iface port1
            set filter rtt loss
        next
    end
end
Parameter Description Type Size Default

addr-mode

Address mode (IPv4 or IPv6)

option

-

Option Description

ipv4

Use IPv4 address.

ipv6

Use IPv6 address.

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

probe-target

IP address or FQDN name of the target to which a probe is sent

port

Port number used to communicate with the server.

integer

1 - 65535

80

http-get

URL used to communicate with the server.

string

/

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.

ip6

Set the source address as a specific IPv6.

src-iface

Set the source address as the address derived from the specified interface.

src-ip

Set the source address as a specific IPv4.

IPv4 address

-

src-ip6

Set the source address as a specific IPv6

IPv6 address

-

filter

Filter type.

option

-

rtt loss

Option Description

rtt

Round trip time.

loss

Packet loss.

config hmon hchk

config hmon hchk

Description: Configure measuring latency/loss/jitter.

config hmon hchk
  edit <name>
    addr-mode [ipv4 | ipv6]
    set protocol [ping | http | dns]
    set interval [1 – 3600]
    set probe-cnt [1 – 10]
    set probe-tm [1 – 10]
    set *probe-target {ipv4-address or FQDN}
    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 | ip6]
    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 *src-ip6 {ipv6-address} *available when src-type is set to ip6
    set filter <name1>, <name2>, …
  next
end

Sample command:

config hmon
    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 port1
            set src-type interface
            set src-iface port1
            set filter rtt loss
        next
    end
end
Parameter Description Type Size Default

addr-mode

Address mode (IPv4 or IPv6)

option

-

Option Description

ipv4

Use IPv4 address.

ipv6

Use IPv6 address.

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

probe-target

IP address or FQDN name of the target to which a probe is sent

port

Port number used to communicate with the server.

integer

1 - 65535

80

http-get

URL used to communicate with the server.

string

/

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.

ip6

Set the source address as a specific IPv6.

src-iface

Set the source address as the address derived from the specified interface.

src-ip

Set the source address as a specific IPv4.

IPv4 address

-

src-ip6

Set the source address as a specific IPv6

IPv6 address

-

filter

Filter type.

option

-

rtt loss

Option Description

rtt

Round trip time.

loss

Packet loss.