netwatch

---

tool/netwatch

Package: advanced-tools
Type: Directory

Flag	Name	Description
X	disabled	disabled

Argument	Type	Description
name	string	The name of the Netwatch probe.
host ( mandatory )	address (flags=46viD)	The IP address or domain name of the server to be probed. See address flags
type	enum (simple | icmp | tcp-conn | http-get | https-get | dns)	Type of the probe (default value: "simple") : simple - simplified ICMP probe, with fewer options than "ICMP" type, used for backward compatibility with the older Netwatch version icmp - (ping-style) series of ICMP request-response with statistics tcp-conn - test TCP connection (3-way handshake) to a server specified by IP and port http-get - do an HTTP Get request and test for a range of correct replies https-get - do an HTTPS Get request and test for a range of correct replies dns - do a specified DNS query for the domain name
src-address ( unset )	address (flags=46)	Source IP address which the Netwatch will try to use in order to reach the host. If the address is not configured on the router or was lost, then the host will be considered as "down". See address flags
interval ( unset )	time	The time interval between probe tests. (default value: 10s)
timeout ( unset )	time	Max time limit to wait for a response. (default value: 3s)
start-delay ( unset )	time	Time to wait before starting the probe. (default value: 3s) (on add, enable, or system startup in cases when "startup-delay" value is smaller then "start-delay" value)
startup-delay ( unset )	time	Time to wait until starting the Netwatch probe after system startup. (default value: 5m)
ignore-initial-up ( unset )	bool	Specifies if "Up" script should be run if the probe state change goes from Unknown to "Up", used to help against false positives after enabling the probe, or after a reboot. "no" means that the change from "Unknown" to "Up" will not be ignored. (default value: no)
ignore-initial-down ( unset )	bool	Specifies if "Down" script should be run if the probe state change goes from Unknown to "Down". "no" means that the change from "Unknown" to "Down" will not be ignored. (default value: no) Warning: Should be used with care, as the first "Down" status won't be executed, and Down script will only be run if the probe goes from "Up" to "Down" state.
up-script ( unset )	alt { , string }	Script to execute on the event of probe state change from "Down" to "Up".
down-script ( unset )	alt { , string }	Script to execute on the event of probe state change from "Up" to "Down".
test-script ( unset )	alt { , string }	Script to execute at the end of every probe test.
packet-interval ( unset )	time	The time between ICMP-request packet sends. This parameter is specific to the ICMP probe type. (default value: 50ms)
packet-count ( unset )	num	Total count of ICMP packets to send out within a single test. This parameter is specific to the ICMP probe type. (default value: 10)
packet-size ( unset )	num	Total size of the IP ICMP packet. This parameter is specific to the ICMP probe type. (default value: 50)
ttl ( unset )	num	Manually sets the time to live value for the ICMP packet. This parameter is specific to the ICMP probe type. (default value: 255)
accept-icmp-time-exceeded ( unset )	bool	If the ICMP "time exceeded" message should be considered a valid response. This parameter is specific to the ICMP probe type. (default value: no)
early-success-detection ( unset )	bool	Netwatch will not wait for all the packets to be processed to change probe status if it is already known that the host will be considered "Down". This parameter is specific to the ICMP probe type. (default value: no)
early-failure-detection ( unset )	bool	Netwatch will not wait for all the packets to be processed to change probe status if it is already known that the host will be considered "Down". This parameter is specific to the ICMP probe type. (default value: no)
thr-max ( unset )	time	Fail threshold for rtt-max. (a value above thr-max is a probe fail) This parameter is specific to the ICMP probe type. (default value: 1s)
thr-avg ( unset )	time	Fail threshold for rtt-avg. (round trip time-avg) This parameter is specific to the ICMP probe type. (default value: 100ms)
thr-stdev ( unset )	time	Fail threshold for rtt-stdev. (standard deviation of round trip time) This parameter is specific to the ICMP probe type. (default value: 250ms)
thr-jitter ( unset )	time	Fail threshold for rtt-jitter. (jitter ( = max - min) of round trip time) This parameter is specific to the ICMP probe type. (default value: 1s)
thr-loss-percent ( unset )	num	Fail threshold for loss-percent. (number of lost packets in percent) This parameter is specific to the ICMP probe type. (default value: 85%)
thr-loss-count ( unset )	num	Fail threshold for loss-count. (number of lost packets) This parameter is specific to the ICMP probe type. (default value: 4294967295(max))
port ( unset )	num	TCP port. This parameter is specific to the TCP-conn and HTTP/S-GET probe types. (default value: 80 (TCP-conn, HTTP-GET) and 443 (HTTPS-GET))
thr-tcp-conn-time ( unset )	time	Fail threshold for tcp-connect-time, the configuration uses microseconds, if the time unit is not specified (s/m/h), log and status pages display the same value in milliseconds. This parameter is specific to the TCP-conn probe type.(default value: 1s)
thr-http-time ( unset )	time	Fail threshold for http-resp-time. This parameter is specific to the HTTP/S-GET probe types. (default value: 10s)
http-codes ( unset )	multi { , , range [100 .. 599] }	Range of HTTP response status codes that are accepted as an "Up" state for the probe. See mozilla-http-status or RFC7231. This parameter is specific to the HTTP/S-GET probe types. (default value: 100-299)
certificate ( unset )	enum (none)	Certificate from the local store that should be used for host verification. This parameter is specific to the HTTPS-GET probe type.
check-certificate ( unset )	bool	Enables trust chain validation from the local certificate store. This parameter is specific to the HTTPS-GET probe type. (default value: no)
record-type ( unset )	enum (A | AAAA | MX | NS)	Record type that will be used for DNS probe. This parameter is specific to the DNS probe type. (default value: A)
dns-server ( unset )	address (flags=46)	The DNS server that the probe should send its requests to; if not specified, it will use the value from /ip/dns. This parameter is specific to the DNS probe type. See address flags

Read-only Argument	Type	Description
status ( unset )	enum (unknown | down | up)	Current status of the probe.
since	date	Last time the status change happened.
done-tests	num	Total number of completed probe tests.
failed-tests	num	Total number of failed probe tests.
sent-count	num	Amount of ICMP packets sent out during last probe test. This parameter is specific to the ICMP probe type.
response-count	num	Amount of ICMP response packets received during last probe test. This parameter is specific to the ICMP probe type.
loss-count	num	Amount of lost ICMP response packets during last probe test. This parameter is specific to the ICMP probe type.
loss-percent	num	Percent of lost ICMP response packets during last probe test. This parameter is specific to the ICMP probe type.
rtt-avg	time	Mean value of round trip time. This parameter is specific to the ICMP probe type.
rtt-min	time	Minimal round trip time. This parameter is specific to the ICMP probe type.
rtt-max	time	Maximum round trip time. This parameter is specific to the ICMP probe type.
rtt-jitter	time	Jitter ( = max - min) of round trip time. This parameter is specific to the ICMP probe type.
rtt-stdev	time	Standard deviation of round trip time. This parameter is specific to the ICMP probe type.
tcp-connect-time	time	Time taken to establish a TCP connection. This parameter is specific to the TCP-conn probe type.
http-status-code	num	HTTP response status code (200 OK, 404 Not Found, etc.). See mozilla-http-status or RFC7231. This parameter is specific to the HTTP/S-GET probe types.
http-resp-time	time	Time taken by the HTTP/S server to send a response after receiving a request, typically measured in milliseconds. This parameter is specific to the HTTP/S-GET probe types.
ip	ipAddr	IPv4 IP address - the result of A record-type probe. This parameter is specific to the DNS probe type.
ip6	ip6Addr	IPv6 IP address - the result of AAAA record-type probe. This parameter is specific to the DNS probe type.
name-servers	multi { array-id, string }	Name servers - the result of NS record-type probe. This parameter is specific to the DNS probe type.
mail-servers	multi { array-id, string }	Mail servers along with their priorities - the result of MX record-type probe. This parameter is specific to the DNS probe type.