CheckNet

Network related check such as check_ping.

CheckNet — CheckNet

Network related check such as check_ping.

Queries (Overview):

A list of all available queries (check commands)

Command	Description
check_ping	Ping another host and check the result.

Commands (Overview):

TODO: Add a list of all external commands (this is not check commands)

Queries

A quick reference for all available queries (check commands) in the CheckNet module.

check_ping

CheckNetcheck_ping

Ping another host and check the result.

Usage:

Option	Default Value	Description
help	N/A	Show help screen (this screen)
help-pb	N/A	Show help screen as a protocol buffer payload
show-default	N/A	Show default values for a given command
help-short	N/A	Show help screen (short format).
debug	N/A	Show debugging information in the log
show-all	N/A	Show debugging information in the log
filter		Filter which marks interesting items.
warning	time > 60 or loss > 5%	Filter which marks items which generates a warning state.
warn		Short alias for warning
critical	time > 100 or loss > 10%	Filter which marks items which generates a critical state.
crit		Short alias for critical.
ok		Filter which marks items which generates an ok state.
empty-state	unknown	Return status to use when nothing matched filter.
perf-config		Performance data generation configuration
top-syntax	${status}: ${problem_count}/${count} (${problem_list})	Top level syntax.
ok-syntax	%(status): All %(count) hosts are ok	ok syntax.
empty-syntax	No hosts found	Empty syntax.
detail-syntax	${ip} Packet loss = ${loss}%, RTA = ${time}ms	Detail level syntax.
perf-syntax	${host}	Performance alias syntax.
host		The host to check (or multiple hosts).
total	N/A	Include the total of all matching hosts
hosts		The host to check (or multiple hosts).
count	1	Number of packets to send.
timeout	500	Timeout in milliseconds.

Arguments

help (CheckNet, check_ping)

Show help screen (this screen)

help-pb (CheckNet, check_ping)

Show help screen as a protocol buffer payload

show-default (CheckNet, check_ping)

Show default values for a given command

help-short (CheckNet, check_ping)

Show help screen (short format).

debug (CheckNet, check_ping)

Show debugging information in the log

show-all (CheckNet, check_ping)

Show debugging information in the log

filter (CheckNet, check_ping)

Filter which marks interesting items.

Interesting items are items which will be included in the check.

They do not denote warning or critical state but they are checked use this to filter out unwanted items.

Available options:

Key	Value
host	The host name or ip address (as given on command line)
ip	The ip address name
loss	Packet loss
recv	Number of packets received from the host
sent	Number of packets sent to the host
time	Round trip time in ms
timeout	Number of packets which timed out from the host
count	Number of items matching the filter
total	Total number of items
ok_count	Number of items matched the ok criteria
warn_count	Number of items matched the warning criteria
crit_count	Number of items matched the critical criteria
problem_count	Number of items matched either warning or critical criteria
list	A list of all items which matched the filter
ok_list	A list of all items which matched the ok criteria
warn_list	A list of all items which matched the warning criteria
crit_list	A list of all items which matched the critical criteria
problem_list	A list of all items which matched either the critical or the warning criteria
detail_list	A special list with critical, then warning and fainally ok
status	The returned status (OK/WARN/CRIT/UNKNOWN)

warning (CheckNet, check_ping)

Filter which marks items which generates a warning state.

If anything matches this filter the return status will be escalated to warning.

Available options:

Key	Value
host	The host name or ip address (as given on command line)
ip	The ip address name
loss	Packet loss
recv	Number of packets received from the host
sent	Number of packets sent to the host
time	Round trip time in ms
timeout	Number of packets which timed out from the host
count	Number of items matching the filter
total	Total number of items
ok_count	Number of items matched the ok criteria
warn_count	Number of items matched the warning criteria
crit_count	Number of items matched the critical criteria
problem_count	Number of items matched either warning or critical criteria
list	A list of all items which matched the filter
ok_list	A list of all items which matched the ok criteria
warn_list	A list of all items which matched the warning criteria
crit_list	A list of all items which matched the critical criteria
problem_list	A list of all items which matched either the critical or the warning criteria
detail_list	A special list with critical, then warning and fainally ok
status	The returned status (OK/WARN/CRIT/UNKNOWN)

warn (CheckNet, check_ping)

Short alias for warning

critical (CheckNet, check_ping)

Filter which marks items which generates a critical state.

If anything matches this filter the return status will be escalated to critical.

Available options:

Key	Value
host	The host name or ip address (as given on command line)
ip	The ip address name
loss	Packet loss
recv	Number of packets received from the host
sent	Number of packets sent to the host
time	Round trip time in ms
timeout	Number of packets which timed out from the host
count	Number of items matching the filter
total	Total number of items
ok_count	Number of items matched the ok criteria
warn_count	Number of items matched the warning criteria
crit_count	Number of items matched the critical criteria
problem_count	Number of items matched either warning or critical criteria
list	A list of all items which matched the filter
ok_list	A list of all items which matched the ok criteria
warn_list	A list of all items which matched the warning criteria
crit_list	A list of all items which matched the critical criteria
problem_list	A list of all items which matched either the critical or the warning criteria
detail_list	A special list with critical, then warning and fainally ok
status	The returned status (OK/WARN/CRIT/UNKNOWN)

crit (CheckNet, check_ping)

Short alias for critical.

ok (CheckNet, check_ping)

Filter which marks items which generates an ok state.

If anything matches this any previous state for this item will be reset to ok.

Available options:

Key	Value
host	The host name or ip address (as given on command line)
ip	The ip address name
loss	Packet loss
recv	Number of packets received from the host
sent	Number of packets sent to the host
time	Round trip time in ms
timeout	Number of packets which timed out from the host
count	Number of items matching the filter
total	Total number of items
ok_count	Number of items matched the ok criteria
warn_count	Number of items matched the warning criteria
crit_count	Number of items matched the critical criteria
problem_count	Number of items matched either warning or critical criteria
list	A list of all items which matched the filter
ok_list	A list of all items which matched the ok criteria
warn_list	A list of all items which matched the warning criteria
crit_list	A list of all items which matched the critical criteria
problem_list	A list of all items which matched either the critical or the warning criteria
detail_list	A special list with critical, then warning and fainally ok
status	The returned status (OK/WARN/CRIT/UNKNOWN)

empty-state (CheckNet, check_ping)

Return status to use when nothing matched filter.

If no filter is specified this will never happen unless the file is empty.

perf-config (CheckNet, check_ping)

Performance data generation configuration

TODO: obj ( key: value; key: value) obj (key:valuer;key:value)

top-syntax (CheckNet, check_ping)

Top level syntax.

Used to format the message to return can include strings as well as special keywords such as:

Key	Value
%(host)	The host name or ip address (as given on command line)
%(ip)	The ip address name
%(loss)	Packet loss
%(recv)	Number of packets received from the host
%(sent)	Number of packets sent to the host
%(time)	Round trip time in ms
%(timeout)	Number of packets which timed out from the host
${count}	Number of items matching the filter
${total}	Total number of items
${ok_count}	Number of items matched the ok criteria
${warn_count}	Number of items matched the warning criteria
${crit_count}	Number of items matched the critical criteria
${problem_count}	Number of items matched either warning or critical criteria
${list}	A list of all items which matched the filter
${ok_list}	A list of all items which matched the ok criteria
${warn_list}	A list of all items which matched the warning criteria
${crit_list}	A list of all items which matched the critical criteria
${problem_list}	A list of all items which matched either the critical or the warning criteria
${detail_list}	A special list with critical, then warning and fainally ok
${status}	The returned status (OK/WARN/CRIT/UNKNOWN)

ok-syntax (CheckNet, check_ping)

ok syntax.

DEPRECATED! This is the syntax for when an ok result is returned.

This value will not be used if your syntax contains %(list) or %(count).

empty-syntax (CheckNet, check_ping)

Empty syntax.

DEPRECATED! This is the syntax for when nothing matches the filter.

Possible values are:

Key	Value
%(host)	The host name or ip address (as given on command line)
%(ip)	The ip address name
%(loss)	Packet loss
%(recv)	Number of packets received from the host
%(sent)	Number of packets sent to the host
%(time)	Round trip time in ms
%(timeout)	Number of packets which timed out from the host
${count}	Number of items matching the filter
${total}	Total number of items
${ok_count}	Number of items matched the ok criteria
${warn_count}	Number of items matched the warning criteria
${crit_count}	Number of items matched the critical criteria
${problem_count}	Number of items matched either warning or critical criteria
${list}	A list of all items which matched the filter
${ok_list}	A list of all items which matched the ok criteria
${warn_list}	A list of all items which matched the warning criteria
${crit_list}	A list of all items which matched the critical criteria
${problem_list}	A list of all items which matched either the critical or the warning criteria
${detail_list}	A special list with critical, then warning and fainally ok
${status}	The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckNet, check_ping)

Detail level syntax.

This is the syntax of each item in the list of top-syntax (see above).

Possible values are:

Key	Value
%(host)	The host name or ip address (as given on command line)
%(ip)	The ip address name
%(loss)	Packet loss
%(recv)	Number of packets received from the host
%(sent)	Number of packets sent to the host
%(time)	Round trip time in ms
%(timeout)	Number of packets which timed out from the host
${count}	Number of items matching the filter
${total}	Total number of items
${ok_count}	Number of items matched the ok criteria
${warn_count}	Number of items matched the warning criteria
${crit_count}	Number of items matched the critical criteria
${problem_count}	Number of items matched either warning or critical criteria
${list}	A list of all items which matched the filter
${ok_list}	A list of all items which matched the ok criteria
${warn_list}	A list of all items which matched the warning criteria
${crit_list}	A list of all items which matched the critical criteria
${problem_list}	A list of all items which matched either the critical or the warning criteria
${detail_list}	A special list with critical, then warning and fainally ok
${status}	The returned status (OK/WARN/CRIT/UNKNOWN)

perf-syntax (CheckNet, check_ping)

Performance alias syntax.

This is the syntax for the base names of the performance data.

Possible values are:

Key	Value
%(host)	The host name or ip address (as given on command line)
%(ip)	The ip address name
%(loss)	Packet loss
%(recv)	Number of packets received from the host
%(sent)	Number of packets sent to the host
%(time)	Round trip time in ms
%(timeout)	Number of packets which timed out from the host
${count}	Number of items matching the filter
${total}	Total number of items
${ok_count}	Number of items matched the ok criteria
${warn_count}	Number of items matched the warning criteria
${crit_count}	Number of items matched the critical criteria
${problem_count}	Number of items matched either warning or critical criteria
${list}	A list of all items which matched the filter
${ok_list}	A list of all items which matched the ok criteria
${warn_list}	A list of all items which matched the warning criteria
${crit_list}	A list of all items which matched the critical criteria
${problem_list}	A list of all items which matched either the critical or the warning criteria
${detail_list}	A special list with critical, then warning and fainally ok
${status}	The returned status (OK/WARN/CRIT/UNKNOWN)

host (CheckNet, check_ping)

The host to check (or multiple hosts).

total (CheckNet, check_ping)

Include the total of all matching hosts

hosts (CheckNet, check_ping)

The host to check (or multiple hosts).

count (CheckNet, check_ping)

Number of packets to send.

timeout (CheckNet, check_ping)

Timeout in milliseconds.

comments powered by Disqus