CheckSystem
Various system related checks, such as CPU load, process state, service state memory usage and PDH counters.

CheckSystem — CheckSystem

Various system related checks, such as CPU load, process state, service state memory usage and PDH counters.

Queries (Overview):

A list of all available queries (check commands)

Command Description
check_cpu Check that the load of the CPU(s) are within bounds.
check_memory Check free/used memory on the system.
check_network Check network interface status.
check_os_version Check the version of the underlaying OS.
check_pagefile Check the size of the system pagefile(s).
check_pdh Check the value of a performance (PDH) counter on the local or remote system.
check_process Check state/metrics of one or more of the processes running on the computer.
check_service Check the state of one or more of the computer services.
check_uptime Check time since last server re-boot.
checkcounter Legacy version of check_pdh
checkcpu Legacy version of check_cpu
checkmem Legacy version of check_mem
checkprocstate Legacy version of check_process
checkservicestate Legacy version of check_service
checkuptime Legacy version of check_uptime

Aliases (Overview):

A list of all short hand aliases for queries (check commands)

Command Description
check_counter Alias for: check_pdh

Commands (Overview):

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

Configuration (Overview):

Common Keys:

Path / Section Key Description
/settings/system/windows default buffer length DEFAULT LENGTH
/settings/system/windows/counters disk_queue_length disk_queue_length
/settings/system/windows/counters/default buffer size BUFFER SIZE
/settings/system/windows/counters/default collection strategy COLLECTION STRATEGY
/settings/system/windows/counters/default counter COUNTER
/settings/system/windows/counters/default flags FLAGS
/settings/system/windows/counters/default instances Interpret instances
/settings/system/windows/counters/default type COUNTER TYPE

Advanced keys:

Path / Section Key Default Value Description
/settings/system/windows subsystem PDH SUBSYSTEM  
/settings/system/windows/counters/default alias ALIAS  
/settings/system/windows/counters/default is template IS TEMPLATE  
/settings/system/windows/counters/default parent PARENT  
/settings/system/windows/counters/sample alias ALIAS  
/settings/system/windows/counters/sample is template IS TEMPLATE  
/settings/system/windows/counters/sample parent PARENT  

Sample keys:

Path / Section Key Default Value Description
/settings/system/windows/counters/sample buffer size BUFFER SIZE  
/settings/system/windows/counters/sample collection strategy COLLECTION STRATEGY  
/settings/system/windows/counters/sample counter COUNTER  
/settings/system/windows/counters/sample flags FLAGS  
/settings/system/windows/counters/sample instances Interpret instances  
/settings/system/windows/counters/sample type COUNTER TYPE  

Queries

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

check_cpu

CheckSystemcheck_cpu
Check that the load of the CPU(s) are within bounds.

Usage:

Option Default Value Description
filter core = ‘total’ Filter which marks interesting items.
warning load > 80 Filter which marks items which generates a warning state.
warn   Short alias for warning
critical load > 90 Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state ignored Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${problem_list} Top level syntax.
ok-syntax %(status): CPU load is ok. ok syntax.
empty-syntax   Empty syntax.
detail-syntax ${time}: ${load}% Detail level syntax.
perf-syntax ${core} ${time} Performance alias syntax.
time   The time to check

Samples

Default check:

check_cpu
CPU Load ok
'total 5m load'=0%;80;90 'total 1m load'=0%;80;90 'total 5s load'=7%;80;90

Checking all cores by adding filter=none (disabling the filter):

check_cpu filter=none “warn=load > 80” “crit=load > 90” CPU Load ok ‘core 0 5m kernel’=1%;10;0 ‘core 0 5m load’=3%;80;90 ‘core 1 5m kernel’=0%;10;0 ‘core 1 5m load’=0%;80;90 ... ‘core 7 5s load’=15%;80;90 ‘total 5s kernel’=3%;10;0 ‘total 5s load’=7%;80;90

Adding kernel times to the check:

check_cpu filter=none "warn=kernel > 10 or load > 80" "crit=load > 90" "top-syntax=${list}"
core 0 > 3, core 1 > 0, core 2 > 0, core  ... , core 7 > 15, total > 7
'core 0 5m kernel'=1%;10;0 'core 0 5m load'=3%;80;90 'core 1 5m kernel'=0%;10;0 'core 1 5m load'=0%;80;90 ...  'core 7 5s load'=15%;80;90 'total 5s kernel'=3%;10;0 'total 5s load'=7%;80;90

Default check via NRPE:

check_nscp --host 192.168.56.103 --command check_cpu
CPU Load ok|'total 5m'=16%;80;90 'total 1m'=13%;80;90 'total 5s'=13%;80;90

Arguments

filter (CheckSystem, check_cpu)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
core The core to check (total or core ##)
core_id The core to check (total or core_##)
idle The current idle load for a given core
kernel The current kernel load for a given core
load The current load for a given core
time The time frame to check
warning (CheckSystem, check_cpu)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
core The core to check (total or core ##)
core_id The core to check (total or core_##)
idle The current idle load for a given core
kernel The current kernel load for a given core
load The current load for a given core
time The time frame to check
warn (CheckSystem, check_cpu)
Short alias for warning
critical (CheckSystem, check_cpu)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
core The core to check (total or core ##)
core_id The core to check (total or core_##)
idle The current idle load for a given core
kernel The current kernel load for a given core
load The current load for a given core
time The time frame to check
crit (CheckSystem, check_cpu)
Short alias for critical.
ok (CheckSystem, check_cpu)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
core The core to check (total or core ##)
core_id The core to check (total or core_##)
idle The current idle load for a given core
kernel The current kernel load for a given core
load The current load for a given core
time The time frame to check
debug (CheckSystem, check_cpu)
Show debugging information in the log
show-all (CheckSystem, check_cpu)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_cpu)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_cpu)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_cpu)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_cpu)
Show help screen (this screen)
help-pb (CheckSystem, check_cpu)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_cpu)
Show default values for a given command
help-short (CheckSystem, check_cpu)
Show help screen (short format).
top-syntax (CheckSystem, check_cpu)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_cpu)
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 (CheckSystem, check_cpu)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_cpu)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
core The core to check (total or core ##)
core_id The core to check (total or core_##)
idle The current idle load for a given core
kernel The current kernel load for a given core
load The current load for a given core
time The time frame to check
perf-syntax (CheckSystem, check_cpu)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
core The core to check (total or core ##)
core_id The core to check (total or core_##)
idle The current idle load for a given core
kernel The current kernel load for a given core
load The current load for a given core
time The time frame to check
time (CheckSystem, check_cpu)
The time to check

check_memory

CheckSystemcheck_memory
Check free/used memory on the system.

Usage:

Option Default Value Description
filter   Filter which marks interesting items.
warning used > 80% Filter which marks items which generates a warning state.
warn   Short alias for warning
critical used > 90% Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state ignored Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${list} Top level syntax.
ok-syntax   ok syntax.
empty-syntax   Empty syntax.
detail-syntax ${type} = ${used} Detail level syntax.
perf-syntax ${type} Performance alias syntax.
type   The type of memory to check (physical = Physical memory (RAM), committed = total memory (RAM+PAGE)

Samples

Default check:

check_memory
OK memory within bounds.
'page used'=8G;19;21 'page used %'=33%;79;89 'physical used'=7G;9;10 'physical used %'=65%;79;89

Using –show-all to show the result:

check_memory "warn=free < 20%" "crit=free < 10G" --show-all
page = 8.05G, physical = 7.85G
'page free'=15G;4;2 'page free %'=66%;19;9 'physical free'=4G;2;1 'physical free %'=34%;19;9

Changing the return syntax to include more information:

check_memory "top-syntax=${list}" "detail-syntax=${type} free: ${free} used: ${used} size: ${size}"
page free: 16G used: 7.98G size: 24G, physical free: 4.18G used: 7.8G size: 12G

Default check via NRPE:

check_nrpe --host 192.168.56.103 --command check_memory
OK memory within bounds.|'page'=531G;3;3;0;3 'page %'=12%;79;89;0;100 'physical'=530G;1;1;0;1 'physical %'=25%;79;89;0;100

Arguments

filter (CheckSystem, check_memory)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
size Total size of memory
type The type of memory to check
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
warning (CheckSystem, check_memory)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
size Total size of memory
type The type of memory to check
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
warn (CheckSystem, check_memory)
Short alias for warning
critical (CheckSystem, check_memory)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
size Total size of memory
type The type of memory to check
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
crit (CheckSystem, check_memory)
Short alias for critical.
ok (CheckSystem, check_memory)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
size Total size of memory
type The type of memory to check
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
debug (CheckSystem, check_memory)
Show debugging information in the log
show-all (CheckSystem, check_memory)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_memory)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_memory)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_memory)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_memory)
Show help screen (this screen)
help-pb (CheckSystem, check_memory)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_memory)
Show default values for a given command
help-short (CheckSystem, check_memory)
Show help screen (short format).
top-syntax (CheckSystem, check_memory)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_memory)
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 (CheckSystem, check_memory)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_memory)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
size Total size of memory
type The type of memory to check
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
perf-syntax (CheckSystem, check_memory)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
size Total size of memory
type The type of memory to check
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
type (CheckSystem, check_memory)
The type of memory to check (physical = Physical memory (RAM), committed = total memory (RAM+PAGE)

check_network

CheckSystemcheck_network
Check network interface status.

Usage:

Option Default Value Description
filter   Filter which marks interesting items.
warning total > 10000 Filter which marks items which generates a warning state.
warn   Short alias for warning
critical total > 100000 Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state critical Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${list} Top level syntax.
ok-syntax %(status): Network interfaces seem ok. ok syntax.
empty-syntax   Empty syntax.
detail-syntax ${name} >${sent} <${received} bps Detail level syntax.
perf-syntax ${name} Performance alias syntax.

Arguments

filter (CheckSystem, check_network)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
MAC The MAC address
enabled True if the network interface is enabled
name Network interface name
net_connection_id Network connection id
received Bytes received per second
sent Bytes sent per second
speed The network interface speed
status Network connection status
total Bytes total per second
warning (CheckSystem, check_network)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
MAC The MAC address
enabled True if the network interface is enabled
name Network interface name
net_connection_id Network connection id
received Bytes received per second
sent Bytes sent per second
speed The network interface speed
status Network connection status
total Bytes total per second
warn (CheckSystem, check_network)
Short alias for warning
critical (CheckSystem, check_network)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
MAC The MAC address
enabled True if the network interface is enabled
name Network interface name
net_connection_id Network connection id
received Bytes received per second
sent Bytes sent per second
speed The network interface speed
status Network connection status
total Bytes total per second
crit (CheckSystem, check_network)
Short alias for critical.
ok (CheckSystem, check_network)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
MAC The MAC address
enabled True if the network interface is enabled
name Network interface name
net_connection_id Network connection id
received Bytes received per second
sent Bytes sent per second
speed The network interface speed
status Network connection status
total Bytes total per second
debug (CheckSystem, check_network)
Show debugging information in the log
show-all (CheckSystem, check_network)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_network)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_network)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_network)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_network)
Show help screen (this screen)
help-pb (CheckSystem, check_network)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_network)
Show default values for a given command
help-short (CheckSystem, check_network)
Show help screen (short format).
top-syntax (CheckSystem, check_network)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_network)
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 (CheckSystem, check_network)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_network)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
MAC The MAC address
enabled True if the network interface is enabled
name Network interface name
net_connection_id Network connection id
received Bytes received per second
sent Bytes sent per second
speed The network interface speed
status Network connection status
total Bytes total per second
perf-syntax (CheckSystem, check_network)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
MAC The MAC address
enabled True if the network interface is enabled
name Network interface name
net_connection_id Network connection id
received Bytes received per second
sent Bytes sent per second
speed The network interface speed
status Network connection status
total Bytes total per second

check_os_version

CheckSystemcheck_os_version
Check the version of the underlaying OS.

Usage:

Option Default Value Description
filter   Filter which marks interesting items.
warning version <= 50 Filter which marks items which generates a warning state.
warn   Short alias for warning
critical version <= 50 Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state ignored Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${list} Top level syntax.
ok-syntax   ok syntax.
empty-syntax   Empty syntax.
detail-syntax ${version} (${major}.${minor}.${build}) Detail level syntax.
perf-syntax version Performance alias syntax.

Samples

Default check:

check_os_Version
L     client CRITICAL: Windows 7 (6.1.7601)
L     client  Performance data: 'version'=61;50;50

Making sure the OS version is Windows 8:

check_os_Version "warn=version < 62"
L     client WARNING: Windows 7 (6.1.7601)
L     client  Performance data: 'version'=61;62;0

Default check via NRPE:

check_nrpe --host 192.168.56.103 --command check_os_version
Windows 2012 (6.2.9200)|'version'=62;50;50

Arguments

filter (CheckSystem, check_os_version)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
build Build version number
major Major version number
minor Minor version number
version The system version
warning (CheckSystem, check_os_version)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
build Build version number
major Major version number
minor Minor version number
version The system version
warn (CheckSystem, check_os_version)
Short alias for warning
critical (CheckSystem, check_os_version)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
build Build version number
major Major version number
minor Minor version number
version The system version
crit (CheckSystem, check_os_version)
Short alias for critical.
ok (CheckSystem, check_os_version)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
build Build version number
major Major version number
minor Minor version number
version The system version
debug (CheckSystem, check_os_version)
Show debugging information in the log
show-all (CheckSystem, check_os_version)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_os_version)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_os_version)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_os_version)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_os_version)
Show help screen (this screen)
help-pb (CheckSystem, check_os_version)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_os_version)
Show default values for a given command
help-short (CheckSystem, check_os_version)
Show help screen (short format).
top-syntax (CheckSystem, check_os_version)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_os_version)
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 (CheckSystem, check_os_version)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_os_version)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
build Build version number
major Major version number
minor Minor version number
version The system version
perf-syntax (CheckSystem, check_os_version)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
build Build version number
major Major version number
minor Minor version number
version The system version

check_pagefile

CheckSystemcheck_pagefile
Check the size of the system pagefile(s).

Usage:

Option Default Value Description
filter   Filter which marks interesting items.
warning used > 60% Filter which marks items which generates a warning state.
warn   Short alias for warning
critical used > 80% Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state ignored Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${list} Top level syntax.
ok-syntax   ok syntax.
empty-syntax   Empty syntax.
detail-syntax ${name} ${used} (${size}) Detail level syntax.
perf-syntax ${name} Performance alias syntax.

Samples

Default options:

check_pagefile
L     client WARNING: \Device\HarddiskVolume2\pagefile.sys 24.3M (32M)
L     client  Performance data: '\??\D:\pagefile.sys'=1G;14;19;0;23 '\??\D:\pagefile.sys %'=6%;59;79;0;100 '\Device\HarddiskVolume2\pagefile.sys'=24M;19;25;0;32 '\Device\HarddiskVolume2\pagefile.sys %'=75%;59;79;0;100 'total'=1G;14;19;0;23 'total %'=6%;59;79;0;100

Only showing the total amount of pagefile usage:

check_pagefile "filter=name = 'total'" "top-syntax=${list}"
OK: total 1.66G (24G)
Performance data: 'total'=1G;14;19;0;23 'total %'=6%;59;79;0;100

Getting help on avalible options:

check_pagefile help
...
  filter=ARG           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.

                                           Avalible options:
                                           free          Free memory in bytes (g,m,k,b) or percentages %
                                           name          The name of the page file (location)
                                           size          Total size of pagefile
                                           used          Used memory in bytes (g,m,k,b) or percentages %
                                           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
...

Arguments

filter (CheckSystem, check_pagefile)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
name The name of the page file (location)
size Total size of pagefile
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
warning (CheckSystem, check_pagefile)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
name The name of the page file (location)
size Total size of pagefile
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
warn (CheckSystem, check_pagefile)
Short alias for warning
critical (CheckSystem, check_pagefile)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
name The name of the page file (location)
size Total size of pagefile
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
crit (CheckSystem, check_pagefile)
Short alias for critical.
ok (CheckSystem, check_pagefile)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
name The name of the page file (location)
size Total size of pagefile
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
debug (CheckSystem, check_pagefile)
Show debugging information in the log
show-all (CheckSystem, check_pagefile)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_pagefile)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_pagefile)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_pagefile)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_pagefile)
Show help screen (this screen)
help-pb (CheckSystem, check_pagefile)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_pagefile)
Show default values for a given command
help-short (CheckSystem, check_pagefile)
Show help screen (short format).
top-syntax (CheckSystem, check_pagefile)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_pagefile)
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 (CheckSystem, check_pagefile)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_pagefile)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
name The name of the page file (location)
size Total size of pagefile
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory
perf-syntax (CheckSystem, check_pagefile)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
free_pct % free memory
name The name of the page file (location)
size Total size of pagefile
used Used memory in bytes (g,m,k,b) or percentages %
used_pct % used memory

check_pdh

CheckSystemcheck_pdh
Check the value of a performance (PDH) counter on the local or remote system.

Usage:

Option Default Value Description
filter   Filter which marks interesting items.
warning   Filter which marks items which generates a warning state.
warn   Short alias for warning
critical   Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state unknown Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${list} Top level syntax.
ok-syntax   ok syntax.
empty-syntax   Empty syntax.
detail-syntax ${alias} = ${value} Detail level syntax.
perf-syntax ${alias} Performance alias syntax.
counter   Performance counter to check
expand-index N/A Expand indexes in counter strings
instances N/A Expand wildcards and fetch all instances
reload N/A Reload counters on errors (useful to check counters which are not added at boot)
averages N/A Check average values (ie. wait for 1 second to collecting two samples)
time   Timeframe to use for named rrd counters
flags   Extra flags to configure the counter (nocap100, 1000, noscale)
type large Format of value (double, long, large)

Samples

Checking specific Counter (SystemSystem Up Time)

check_pdh "counter=\\System\\System Up Time" "warn=value > 5" "crit=value > 9999"
\System\System Up Time = 204213
'\System\System Up Time value'=204213;5;9999

Using the expand index to check for translated counters:

check_pdh "counter=\\4\\30" "warn=value > 5" "crit=value > 9999" expand-index
Everything looks good
'\Minne\Dedikationsgräns value'=-2147483648;5;9999

Checking translated counters without expanding indexes:

check_pdh "counter=\\4\\30" "warn=value > 5" "crit=value > 9999"
Everything looks good
'\4\30 value'=-2147483648;5;9999

Checking large values using the type=large keyword:

check_pdh "counter=\\4\\30" "warn=value > 5" "crit=value > 9999" flags=nocap100 expand-index type=large
\Minne\Dedikationsgräns = 25729224704
'\Minne\Dedikationsgräns value'=25729224704;5;9999

Using real-time checks to check avergae values over time.

Here we configure a counter to be checked at regular intervals and the value is added to a rrd buffer. The configuration from nsclient.ini:

[/settings/system/windows/counters/foo]
collection strategy=rrd
type=large
counter=\Processor(_total)\% Processor Time

Then we can check the value (current snapshot):

check_pdh "counter=foo" "warn=value > 80" "crit=value > 90"
Everything looks good
'foo value'=18;80;90

To check averages from the same counter we need to specify the time option:

check_pdh "counter=foo" "warn=value > 80" "crit=value > 90" time=30s
Everything looks good
'foo value'=3;80;90

Checking all instances of a given counter:

check_pdh "counter=\Processor(*)\% processortid" instances
    L     client OK: \\MIME-LAPTOP\Processor(0)\% processortid = 100, \\MIME-LAPTOP\Processor(1)\% processortid = 100, \\MIME-LAPTOP\Processor(2)\% processortid = 100, \\MIME-LAPTOP\Processor(3)\% processortid = 100, \\MIME-LAPTOP\Processor(4)\% processortid = 100, \\MIME-LAPTOP\Processor(5)\% processortid = 100, \\MIME-LAPTOP\Processor(6)\% processortid = 100, \\MIME-LAPTOP\Processor(7)\% processortid = 100, \\MIME-LAPTOP\Processor(_Total)\% processortid = 100
L     client  Performance data: '\Processor(*)\% processortid_0'=100;0;0 '\Processor(*)\% processortid_1'=100;0;0 '\Processor(*)\% processortid_2'=100;0;0 '\Processor(*)\% processortid_3'=100;0;0 '\Processor(*)\% processortid_4'=100;0;0 '\Processor(*)\% processortid_5'=100;0;0 '\Processor(*)\% processortid_6'=100;0;0 '\Processor(*)\% processortid_7'=100;0;0 '\Processor(*)\% processortid__Total'=100;0;0

Arguments

filter (CheckSystem, check_pdh)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
alias The counter alias
counter The counter name
time The time for rrd checks
value The counter value (either float or int)
value_f The counter value (force float value)
value_i The counter value (force int value)
warning (CheckSystem, check_pdh)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
alias The counter alias
counter The counter name
time The time for rrd checks
value The counter value (either float or int)
value_f The counter value (force float value)
value_i The counter value (force int value)
warn (CheckSystem, check_pdh)
Short alias for warning
critical (CheckSystem, check_pdh)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
alias The counter alias
counter The counter name
time The time for rrd checks
value The counter value (either float or int)
value_f The counter value (force float value)
value_i The counter value (force int value)
crit (CheckSystem, check_pdh)
Short alias for critical.
ok (CheckSystem, check_pdh)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
alias The counter alias
counter The counter name
time The time for rrd checks
value The counter value (either float or int)
value_f The counter value (force float value)
value_i The counter value (force int value)
debug (CheckSystem, check_pdh)
Show debugging information in the log
show-all (CheckSystem, check_pdh)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_pdh)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_pdh)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_pdh)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_pdh)
Show help screen (this screen)
help-pb (CheckSystem, check_pdh)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_pdh)
Show default values for a given command
help-short (CheckSystem, check_pdh)
Show help screen (short format).
top-syntax (CheckSystem, check_pdh)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_pdh)
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 (CheckSystem, check_pdh)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_pdh)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
alias The counter alias
counter The counter name
time The time for rrd checks
value The counter value (either float or int)
value_f The counter value (force float value)
value_i The counter value (force int value)
perf-syntax (CheckSystem, check_pdh)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
alias The counter alias
counter The counter name
time The time for rrd checks
value The counter value (either float or int)
value_f The counter value (force float value)
value_i The counter value (force int value)
counter (CheckSystem, check_pdh)
Performance counter to check
expand-index (CheckSystem, check_pdh)
Expand indexes in counter strings
instances (CheckSystem, check_pdh)
Expand wildcards and fetch all instances
reload (CheckSystem, check_pdh)
Reload counters on errors (useful to check counters which are not added at boot)
averages (CheckSystem, check_pdh)
Check average values (ie. wait for 1 second to collecting two samples)
time (CheckSystem, check_pdh)
Timeframe to use for named rrd counters
flags (CheckSystem, check_pdh)
Extra flags to configure the counter (nocap100, 1000, noscale)
type (CheckSystem, check_pdh)
Format of value (double, long, large)

check_process

CheckSystemcheck_process
Check state/metrics of one or more of the processes running on the computer.

Usage:

Option Default Value Description
filter state != ‘unreadable’ Filter which marks interesting items.
warning state not in (‘started’) Filter which marks items which generates a warning state.
warn   Short alias for warning
critical state = ‘stopped’, count = 0 Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state unknown Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${problem_list} Top level syntax.
ok-syntax %(status): all processes are ok. ok syntax.
empty-syntax %(status): No processes found Empty syntax.
detail-syntax ${exe}=${state} Detail level syntax.
perf-syntax ${exe} Performance alias syntax.
process   The service to check, set this to * to check all services
scan-info   If all process metrics should be fetched (otherwise only status is fetched)
scan-16bit   If 16bit processes should be included
delta   Calculate delta over one elapsed second.
scan-unreadable   If unreadable processes should be included (will not have information)
total N/A Include the total of all matching files

Samples

Default check:

check_process
SetPoint.exe=hung
Performance data: 'taskhost.exe'=1;1;0 'dwm.exe'=1;1;0 'explorer.exe'=1;1;0 ... 'chrome.exe'=1;1;0 'vcpkgsrv.exe'=1;1;0 'vcpkgsrv.exe'=1;1;0

Default check via NRPE:

check_nrpe --host 192.168.56.103 --command check_process
SetPoint.exe=hung|'smss.exe state'=1;0;0 'csrss.exe state'=1;0;0...

Check that specific process are running:

check_process process=explorer.exe process=foo.exe
foo.exe=stopped
Performance data: 'explorer.exe'=1;1;0 'foo.exe'=0;1;0

Check memory footprint from specific processes:

check_process process=explorer.exe "warn=working_set > 70m"
explorer.exe=started
Performance data: 'explorer.exe ws_size'=73M;70;0

Extend the syntax to display the attributes we are interested in:

check_process process=explorer.exe "warn=working_set > 70m" "detail-syntax=${exe} ws:${working_set}, handles: ${handles}, user time:${user}s"
explorer.exe ws:77271040, handles: 800, user time:107s
Performance data: 'explorer.exe ws_size'=73M;70;0

List all processes which use more then 200m virtual memory Default check via NRPE:

check_nrpe --host 192.168.56.103 --command check_process --arguments "filter=virtual > 200m"
OK all processes are ok.|'csrss.exe state'=1;0;0 'svchost.exe state'=1;0;0 'AvastSvc.exe state'=1;0;0 ...

Arguments

filter (CheckSystem, check_process)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
warning (CheckSystem, check_process)
Filter which marks items which generates a warning state.
If anything matches this filter the return status will be escalated to warning.
warn (CheckSystem, check_process)
Short alias for warning
critical (CheckSystem, check_process)
Filter which marks items which generates a critical state.
If anything matches this filter the return status will be escalated to critical.
crit (CheckSystem, check_process)
Short alias for critical.
ok (CheckSystem, check_process)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
command_line Command line of process (not always available)
creation Creation time
error Any error messages associated with fetching info
exe The name of the executable
filename Name of process (with path)
gdi_handles Number of handles
handles Number of handles
hung Process is hung
kernel Kernel time in seconds
legacy_state Get process status (for legacy use via check_nt only)
page_fault Page fault count
pagefile Peak page file use in bytes
peak_pagefile Page file usage in bytes
peak_virtual Peak virtual size in bytes
peak_working_set Peak working set in bytes
pid Process id
started Process is started
state The current state (started, stopped hung)
stopped Process is stopped
time User-kernel time in seconds
user User time in seconds
user_handles Number of handles
virtual Virtual size in bytes
working_set Working set in bytes
debug (CheckSystem, check_process)
Show debugging information in the log
show-all (CheckSystem, check_process)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_process)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_process)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_process)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_process)
Show help screen (this screen)
help-pb (CheckSystem, check_process)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_process)
Show default values for a given command
help-short (CheckSystem, check_process)
Show help screen (short format).
top-syntax (CheckSystem, check_process)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_process)
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 (CheckSystem, check_process)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_process)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
command_line Command line of process (not always available)
creation Creation time
error Any error messages associated with fetching info
exe The name of the executable
filename Name of process (with path)
gdi_handles Number of handles
handles Number of handles
hung Process is hung
kernel Kernel time in seconds
legacy_state Get process status (for legacy use via check_nt only)
page_fault Page fault count
pagefile Peak page file use in bytes
peak_pagefile Page file usage in bytes
peak_virtual Peak virtual size in bytes
peak_working_set Peak working set in bytes
pid Process id
started Process is started
state The current state (started, stopped hung)
stopped Process is stopped
time User-kernel time in seconds
user User time in seconds
user_handles Number of handles
virtual Virtual size in bytes
working_set Working set in bytes
perf-syntax (CheckSystem, check_process)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
command_line Command line of process (not always available)
creation Creation time
error Any error messages associated with fetching info
exe The name of the executable
filename Name of process (with path)
gdi_handles Number of handles
handles Number of handles
hung Process is hung
kernel Kernel time in seconds
legacy_state Get process status (for legacy use via check_nt only)
page_fault Page fault count
pagefile Peak page file use in bytes
peak_pagefile Page file usage in bytes
peak_virtual Peak virtual size in bytes
peak_working_set Peak working set in bytes
pid Process id
started Process is started
state The current state (started, stopped hung)
stopped Process is stopped
time User-kernel time in seconds
user User time in seconds
user_handles Number of handles
virtual Virtual size in bytes
working_set Working set in bytes
process (CheckSystem, check_process)
The service to check, set this to * to check all services
scan-info (CheckSystem, check_process)
If all process metrics should be fetched (otherwise only status is fetched)
scan-16bit (CheckSystem, check_process)
If 16bit processes should be included
delta (CheckSystem, check_process)
Calculate delta over one elapsed second.
This call will measure values and then sleep for 2 second and then measure again calculating deltas.
scan-unreadable (CheckSystem, check_process)
If unreadable processes should be included (will not have information)
total (CheckSystem, check_process)
Include the total of all matching files

check_service

CheckSystemcheck_service
Check the state of one or more of the computer services.

Usage:

Option Default Value Description
filter   Filter which marks interesting items.
warning not state_is_perfect() Filter which marks items which generates a warning state.
warn   Short alias for warning
critical not state_is_ok() Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state unknown Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${crit_list}, delayed (${warn_list}) Top level syntax.
ok-syntax %(status): All %(count) service(s) are ok. ok syntax.
empty-syntax %(status): No services found Empty syntax.
detail-syntax ${name}=${state} (${start_type}) Detail level syntax.
perf-syntax ${name} Performance alias syntax.
computer   The name of the remote computer to check
service   The service to check, set this to * to check all services
exclude   A list of services to ignore (mainly usefull in combination with service=*)
type service The types of services to enumerate available types are driver, file-system-driver, kernel-driver, service, service-own-process, service-share-process
state all The types of services to enumerate available states are active, inactive or all
only-essential N/A Set filter to classification = ‘essential’
only-ignored N/A Set filter to classification = ‘ignored’
only-role N/A Set filter to classification = ‘role’
only-supporting N/A Set filter to classification = ‘supporting’
only-system N/A Set filter to classification = ‘system’
only-user N/A Set filter to classification = ‘user’

Samples

Default check:

check_service
OK all services are ok.

Excluding services using exclude:

check_service "exclude=clr_optimization_v4.0.30319_32"  "exclude=clr_optimization_v4.0.30319_64"
WARNING: gupdate=stopped (auto), Net Driver HPZ12=stopped (auto), NSClientpp=stopped (auto), nscp=stopped (auto), Pml Driver HPZ12=stopped (auto), SkypeUpdate=stopped (auto), sppsvc=stopped (auto)

Show all service by changing the syntax:

check_service "top-syntax=${list}" "detail-syntax=${name}:${state}"
AdobeActiveFileMonitor10.0:running, AdobeARMservice:running, AdobeFlashPlayerUpdateSvc:stopped, ..., WwanSvc:stopped

Excluding services using the filter:

check_service "filter=start_type = 'auto' and name not in ('Bonjour Service', 'Net Driver HPZ12')"
AdobeActiveFileMonitor10.0: running, AdobeARMservice: running, AMD External Events Utility: running,  ... wuauserv: running

Default check via NRPE:

check_nrpe --host 192.168.56.103 --command check_service
WARNING: DPS=stopped (auto), MSDTC=stopped (auto), sppsvc=stopped (auto), UALSVC=stopped (auto)

Check that a service is not started:

check_service service=nscp "crit=state = 'started'" warn=none

Arguments

filter (CheckSystem, check_service)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
classification Get classification
delayed If the service is delayed
desc Service description
is_trigger If the service is has associated triggers
legacy_state Get legacy state (deprecated and only used by check_nt)
name Service name
pid Process id
start_type The configured start type ()
state The current state ()
triggers The number of associated triggers for this service
state_is_ok() Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped)
state_is_perfect() Check if the state is ok, i.e. all running services are running
warning (CheckSystem, check_service)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
classification Get classification
delayed If the service is delayed
desc Service description
is_trigger If the service is has associated triggers
legacy_state Get legacy state (deprecated and only used by check_nt)
name Service name
pid Process id
start_type The configured start type ()
state The current state ()
triggers The number of associated triggers for this service
state_is_ok() Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped)
state_is_perfect() Check if the state is ok, i.e. all running services are running
warn (CheckSystem, check_service)
Short alias for warning
critical (CheckSystem, check_service)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
classification Get classification
delayed If the service is delayed
desc Service description
is_trigger If the service is has associated triggers
legacy_state Get legacy state (deprecated and only used by check_nt)
name Service name
pid Process id
start_type The configured start type ()
state The current state ()
triggers The number of associated triggers for this service
state_is_ok() Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped)
state_is_perfect() Check if the state is ok, i.e. all running services are running
crit (CheckSystem, check_service)
Short alias for critical.
ok (CheckSystem, check_service)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
classification Get classification
delayed If the service is delayed
desc Service description
is_trigger If the service is has associated triggers
legacy_state Get legacy state (deprecated and only used by check_nt)
name Service name
pid Process id
start_type The configured start type ()
state The current state ()
triggers The number of associated triggers for this service
state_is_ok() Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped)
state_is_perfect() Check if the state is ok, i.e. all running services are running
debug (CheckSystem, check_service)
Show debugging information in the log
show-all (CheckSystem, check_service)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_service)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_service)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_service)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_service)
Show help screen (this screen)
help-pb (CheckSystem, check_service)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_service)
Show default values for a given command
help-short (CheckSystem, check_service)
Show help screen (short format).
top-syntax (CheckSystem, check_service)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_service)
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 (CheckSystem, check_service)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_service)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
classification Get classification
delayed If the service is delayed
desc Service description
is_trigger If the service is has associated triggers
legacy_state Get legacy state (deprecated and only used by check_nt)
name Service name
pid Process id
start_type The configured start type ()
state The current state ()
triggers The number of associated triggers for this service
state_is_ok() Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped)
state_is_perfect() Check if the state is ok, i.e. all running services are running
perf-syntax (CheckSystem, check_service)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
classification Get classification
delayed If the service is delayed
desc Service description
is_trigger If the service is has associated triggers
legacy_state Get legacy state (deprecated and only used by check_nt)
name Service name
pid Process id
start_type The configured start type ()
state The current state ()
triggers The number of associated triggers for this service
state_is_ok() Check if the state is ok, i.e. all running services are runningelayed services are allowed to be stopped)
state_is_perfect() Check if the state is ok, i.e. all running services are running
computer (CheckSystem, check_service)
The name of the remote computer to check
service (CheckSystem, check_service)
The service to check, set this to * to check all services
exclude (CheckSystem, check_service)
A list of services to ignore (mainly usefull in combination with service=*)
type (CheckSystem, check_service)
The types of services to enumerate available types are driver, file-system-driver, kernel-driver, service, service-own-process, service-share-process
state (CheckSystem, check_service)
The types of services to enumerate available states are active, inactive or all
only-essential (CheckSystem, check_service)
Set filter to classification = ‘essential’
only-ignored (CheckSystem, check_service)
Set filter to classification = ‘ignored’
only-role (CheckSystem, check_service)
Set filter to classification = ‘role’
only-supporting (CheckSystem, check_service)
Set filter to classification = ‘supporting’
only-system (CheckSystem, check_service)
Set filter to classification = ‘system’
only-user (CheckSystem, check_service)
Set filter to classification = ‘user’

check_uptime

CheckSystemcheck_uptime
Check time since last server re-boot.

Usage:

Option Default Value Description
filter   Filter which marks interesting items.
warning uptime < 2d Filter which marks items which generates a warning state.
warn   Short alias for warning
critical uptime < 1d Filter which marks items which generates a critical state.
crit   Short alias for critical.
ok   Filter which marks items which generates an ok state.
debug N/A Show debugging information in the log
show-all N/A Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state ignored Return status to use when nothing matched filter.
perf-config   Performance data generation configuration
escape-html N/A Escape any < and > characters to prevent HTML encoding
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).
top-syntax ${status}: ${list} Top level syntax.
ok-syntax   ok syntax.
empty-syntax   Empty syntax.
detail-syntax uptime: ${uptime}h, boot: ${boot} (UTC) Detail level syntax.
perf-syntax uptime Performance alias syntax.

Samples

Default check:

check_uptime
uptime: -9:02, boot: 2013-aug-18 08:29:13
'uptime uptime'=1376814553s;1376760683;1376803883

Adding warning and critical thresholds:

check_uptime "warn=uptime < -2d" "crit=uptime < -1d"
...

Default check via NRPE:

check_nrpe --host 192.168.56.103 --command check_uptime
uptime: -0:3, boot: 2013-sep-08 18:41:06 (UCT)|'uptime'=1378665666;1378579481;1378622681

Arguments

filter (CheckSystem, check_uptime)
Filter which marks interesting items.
Interesting items are items which will be included in the check.
They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
Available options :
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
boot System boot time
uptime Time since last boot
warning (CheckSystem, check_uptime)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
boot System boot time
uptime Time since last boot
warn (CheckSystem, check_uptime)
Short alias for warning
critical (CheckSystem, check_uptime)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
boot System boot time
uptime Time since last boot
crit (CheckSystem, check_uptime)
Short alias for critical.
ok (CheckSystem, check_uptime)
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
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
boot System boot time
uptime Time since last boot
debug (CheckSystem, check_uptime)
Show debugging information in the log
show-all (CheckSystem, check_uptime)
Show details for all matches regardless of status (normally details are only showed for warnings and criticals).
empty-state (CheckSystem, check_uptime)
Return status to use when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
perf-config (CheckSystem, check_uptime)
Performance data generation configuration
TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
escape-html (CheckSystem, check_uptime)
Escape any < and > characters to prevent HTML encoding
help (CheckSystem, check_uptime)
Show help screen (this screen)
help-pb (CheckSystem, check_uptime)
Show help screen as a protocol buffer payload
show-default (CheckSystem, check_uptime)
Show default values for a given command
help-short (CheckSystem, check_uptime)
Show help screen (short format).
top-syntax (CheckSystem, check_uptime)
Top level syntax.
Used to format the message to return can include text as well as special keywords which will include information from the checks.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
ok-syntax (CheckSystem, check_uptime)
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 (CheckSystem, check_uptime)
Empty syntax.
DEPRECATED! This is the syntax for when nothing matches the filter.
Possible values are:
Key Value
count Number of items matching the filter. Common option for all checks.
total Total number of items. Common option for all checks.
ok_count Number of items matched the ok criteria. Common option for all checks.
warn_count Number of items matched the warning criteria. Common option for all checks.
crit_count Number of items matched the critical criteria. Common option for all checks.
problem_count Number of items matched either warning or critical criteria. Common option for all checks.
list A list of all items which matched the filter. Common option for all checks.
ok_list A list of all items which matched the ok criteria. Common option for all checks.
warn_list A list of all items which matched the warning criteria. Common option for all checks.
crit_list A list of all items which matched the critical criteria. Common option for all checks.
problem_list A list of all items which matched either the critical or the warning criteria. Common option for all checks.
detail_list A special list with critical, then warning and finally ok. Common option for all checks.
status The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks.
detail-syntax (CheckSystem, check_uptime)
Detail level syntax.
Used to format each resulting item in the message.
%(list) will be replaced with all the items formated by this syntax string in the top-syntax.
To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to excpae on linux).
The available keywords are:
Key Value
boot System boot time
uptime Time since last boot
perf-syntax (CheckSystem, check_uptime)
Performance alias syntax.
This is the syntax for the base names of the performance data.
Possible values are:
Key Value
boot System boot time
uptime Time since last boot

checkcounter

CheckSystemcheckcounter
Legacy version of check_pdh

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).
Counter   The time to check
ShowAll short Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn   Maximum value before a warning is returned.
MaxCrit   Maximum value before a critical is returned.
MinWarn   Minimum value before a warning is returned.
MinCrit   Minimum value before a critical is returned.

Arguments

help (CheckSystem, checkcounter)
Show help screen (this screen)
help-pb (CheckSystem, checkcounter)
Show help screen as a protocol buffer payload
show-default (CheckSystem, checkcounter)
Show default values for a given command
help-short (CheckSystem, checkcounter)
Show help screen (short format).
Counter (CheckSystem, checkcounter)
The time to check
ShowAll (CheckSystem, checkcounter)
Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn (CheckSystem, checkcounter)
Maximum value before a warning is returned.
MaxCrit (CheckSystem, checkcounter)
Maximum value before a critical is returned.
MinWarn (CheckSystem, checkcounter)
Minimum value before a warning is returned.
MinCrit (CheckSystem, checkcounter)
Minimum value before a critical is returned.

checkcpu

CheckSystemcheckcpu
Legacy version of check_cpu

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).
time   The time to check
ShowAll short Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn   Maximum value before a warning is returned.
MaxCrit   Maximum value before a critical is returned.
MinWarn   Minimum value before a warning is returned.
MinCrit   Minimum value before a critical is returned.
warn   Maximum value before a warning is returned.
crit   Maximum value before a critical is returned.

Arguments

help (CheckSystem, checkcpu)
Show help screen (this screen)
help-pb (CheckSystem, checkcpu)
Show help screen as a protocol buffer payload
show-default (CheckSystem, checkcpu)
Show default values for a given command
help-short (CheckSystem, checkcpu)
Show help screen (short format).
time (CheckSystem, checkcpu)
The time to check
ShowAll (CheckSystem, checkcpu)
Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn (CheckSystem, checkcpu)
Maximum value before a warning is returned.
MaxCrit (CheckSystem, checkcpu)
Maximum value before a critical is returned.
MinWarn (CheckSystem, checkcpu)
Minimum value before a warning is returned.
MinCrit (CheckSystem, checkcpu)
Minimum value before a critical is returned.
warn (CheckSystem, checkcpu)
Maximum value before a warning is returned.
crit (CheckSystem, checkcpu)
Maximum value before a critical is returned.

checkmem

CheckSystemcheckmem
Legacy version of check_mem

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).
type   The types to check
ShowAll short Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn   Maximum value before a warning is returned.
MaxCrit   Maximum value before a critical is returned.
MinWarn   Minimum value before a warning is returned.
MinCrit   Minimum value before a critical is returned.
warn   Maximum value before a warning is returned.
crit   Maximum value before a critical is returned.

Arguments

help (CheckSystem, checkmem)
Show help screen (this screen)
help-pb (CheckSystem, checkmem)
Show help screen as a protocol buffer payload
show-default (CheckSystem, checkmem)
Show default values for a given command
help-short (CheckSystem, checkmem)
Show help screen (short format).
type (CheckSystem, checkmem)
The types to check
ShowAll (CheckSystem, checkmem)
Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn (CheckSystem, checkmem)
Maximum value before a warning is returned.
MaxCrit (CheckSystem, checkmem)
Maximum value before a critical is returned.
MinWarn (CheckSystem, checkmem)
Minimum value before a warning is returned.
MinCrit (CheckSystem, checkmem)
Minimum value before a critical is returned.
warn (CheckSystem, checkmem)
Maximum value before a warning is returned.
crit (CheckSystem, checkmem)
Maximum value before a critical is returned.

checkprocstate

CheckSystemcheckprocstate
Legacy version of check_process

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).
ShowAll short Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarnCount   Maximum value before a warning is returned.
MaxCritCount   Maximum value before a critical is returned.
MinWarnCount   Minimum value before a warning is returned.
MinCritCount   Minimum value before a critical is returned.

Arguments

help (CheckSystem, checkprocstate)
Show help screen (this screen)
help-pb (CheckSystem, checkprocstate)
Show help screen as a protocol buffer payload
show-default (CheckSystem, checkprocstate)
Show default values for a given command
help-short (CheckSystem, checkprocstate)
Show help screen (short format).
ShowAll (CheckSystem, checkprocstate)
Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarnCount (CheckSystem, checkprocstate)
Maximum value before a warning is returned.
MaxCritCount (CheckSystem, checkprocstate)
Maximum value before a critical is returned.
MinWarnCount (CheckSystem, checkprocstate)
Minimum value before a warning is returned.
MinCritCount (CheckSystem, checkprocstate)
Minimum value before a critical is returned.

checkservicestate

CheckSystemcheckservicestate
Legacy version of check_service

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).
CheckAll true Check all services.
exclude   Exclude services
ShowAll short Configures display format (if set shows all items not only failures, if set to long shows all cores).

Arguments

help (CheckSystem, checkservicestate)
Show help screen (this screen)
help-pb (CheckSystem, checkservicestate)
Show help screen as a protocol buffer payload
show-default (CheckSystem, checkservicestate)
Show default values for a given command
help-short (CheckSystem, checkservicestate)
Show help screen (short format).
CheckAll (CheckSystem, checkservicestate)
Check all services.
exclude (CheckSystem, checkservicestate)
Exclude services
ShowAll (CheckSystem, checkservicestate)
Configures display format (if set shows all items not only failures, if set to long shows all cores).

checkuptime

CheckSystemcheckuptime
Legacy version of check_uptime

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).
ShowAll short Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn   Maximum value before a warning is returned.
MaxCrit   Maximum value before a critical is returned.
MinWarn   Minimum value before a warning is returned.
MinCrit   Minimum value before a critical is returned.
warn   Maximum value before a warning is returned.
crit   Maximum value before a critical is returned.

Arguments

help (CheckSystem, checkuptime)
Show help screen (this screen)
help-pb (CheckSystem, checkuptime)
Show help screen as a protocol buffer payload
show-default (CheckSystem, checkuptime)
Show default values for a given command
help-short (CheckSystem, checkuptime)
Show help screen (short format).
ShowAll (CheckSystem, checkuptime)
Configures display format (if set shows all items not only failures, if set to long shows all cores).
MaxWarn (CheckSystem, checkuptime)
Maximum value before a warning is returned.
MaxCrit (CheckSystem, checkuptime)
Maximum value before a critical is returned.
MinWarn (CheckSystem, checkuptime)
Minimum value before a warning is returned.
MinCrit (CheckSystem, checkuptime)
Minimum value before a critical is returned.
warn (CheckSystem, checkuptime)
Maximum value before a warning is returned.
crit (CheckSystem, checkuptime)
Maximum value before a critical is returned.

/ settings/ system/ windows

/settings/system/windows (CheckSystem)

WINDOWS CHECK SYSTEM

Section for system checks and system settings
Key Default Value Description
default buffer length 1h DEFAULT LENGTH
subsystem default PDH SUBSYSTEM

Sample:

# WINDOWS CHECK SYSTEM
# Section for system checks and system settings
[/settings/system/windows]
default buffer length=1h
subsystem=default
default buffer length (CheckSystem, /settings/system/windows)

DEFAULT LENGTH

Used to define the default interval for range buffer checks (ie. CPU).

Path: /settings/system/windows

Key: default buffer length

Default value: 1h

Used by: CheckSystem

Sample:

[/settings/system/windows]
# DEFAULT LENGTH
default buffer length=1h
subsystem (CheckSystem, /settings/system/windows)

PDH SUBSYSTEM

Set which pdh subsystem to use.

Advanced (means it is not commonly used)

Path: /settings/system/windows

Key: subsystem

Default value: default

Used by: CheckSystem

Sample:

[/settings/system/windows]
# PDH SUBSYSTEM
subsystem=default

… / counters

/settings/system/windows/counters (CheckSystem)

COUNTERS

Add counters to check
Key Default Value Description
disk_queue_length   disk_queue_length

Sample:

# COUNTERS
# Add counters to check
[/settings/system/windows/counters]
disk_queue_length=
disk_queue_length (CheckSystem, /settings/system/windows/counters)

disk_queue_length

To configure this create a section under: /settings/system/windows/counters/disk_queue_length

Path: /settings/system/windows/counters

Key: disk_queue_length

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters]
# disk_queue_length
disk_queue_length=

… / counters / default

/settings/system/windows/counters/default (CheckSystem)

COUNTER

Definition for counter: default
Key Default Value Description
alias   ALIAS
buffer size   BUFFER SIZE
collection strategy   COLLECTION STRATEGY
counter   COUNTER
flags   FLAGS
instances   Interpret instances
is template 0 IS TEMPLATE
parent default PARENT
type   COUNTER TYPE

Sample:

# COUNTER
# Definition for counter: default
[/settings/system/windows/counters/default]
alias=
buffer size=
collection strategy=
counter=
flags=
instances=
is template=0
parent=default
type=
alias (CheckSystem, /settings/system/windows/counters/default)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/system/windows/counters/default

Key: alias

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# ALIAS
alias=
buffer size (CheckSystem, /settings/system/windows/counters/default)

BUFFER SIZE

Size of buffer (in seconds) larger buffer use more memory

Path: /settings/system/windows/counters/default

Key: buffer size

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# BUFFER SIZE
buffer size=
collection strategy (CheckSystem, /settings/system/windows/counters/default)

COLLECTION STRATEGY

The way to handled values when collecting them: static means we keep the last known value, rrd means we store values in a buffer from which you can retrieve the average

Path: /settings/system/windows/counters/default

Key: collection strategy

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# COLLECTION STRATEGY
collection strategy=
counter (CheckSystem, /settings/system/windows/counters/default)

COUNTER

The counter to check

Path: /settings/system/windows/counters/default

Key: counter

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# COUNTER
counter=
flags (CheckSystem, /settings/system/windows/counters/default)

FLAGS

Extra flags to configure the counter (nocap100, 1000, noscale)

Path: /settings/system/windows/counters/default

Key: flags

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# FLAGS
flags=
instances (CheckSystem, /settings/system/windows/counters/default)

Interpret instances

IF we shoul interpret instance (default auto). Values: auto, true, false

Path: /settings/system/windows/counters/default

Key: instances

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# Interpret instances
instances=
is template (CheckSystem, /settings/system/windows/counters/default)

IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/system/windows/counters/default

Key: is template

Default value: 0

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# IS TEMPLATE
is template=0
parent (CheckSystem, /settings/system/windows/counters/default)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/system/windows/counters/default

Key: parent

Default value: default

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# PARENT
parent=default
type (CheckSystem, /settings/system/windows/counters/default)

COUNTER TYPE

The type of counter to use long, large and double

Path: /settings/system/windows/counters/default

Key: type

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/default]
# COUNTER TYPE
type=

… / counters / sample

/settings/system/windows/counters/sample (CheckSystem)

COUNTER

Definition for counter: sample
Key Default Value Description
alias   ALIAS
buffer size   BUFFER SIZE
collection strategy   COLLECTION STRATEGY
counter   COUNTER
flags   FLAGS
instances   Interpret instances
is template 0 IS TEMPLATE
parent default PARENT
type   COUNTER TYPE

Sample:

# COUNTER
# Definition for counter: sample
[/settings/system/windows/counters/sample]
alias=
buffer size=
collection strategy=
counter=
flags=
instances=
is template=0
parent=default
type=
alias (CheckSystem, /settings/system/windows/counters/sample)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/system/windows/counters/sample

Key: alias

Default value:

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# ALIAS
alias=
buffer size (CheckSystem, /settings/system/windows/counters/sample)

BUFFER SIZE

Size of buffer (in seconds) larger buffer use more memory

Path: /settings/system/windows/counters/sample

Key: buffer size

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# BUFFER SIZE
buffer size=
collection strategy (CheckSystem, /settings/system/windows/counters/sample)

COLLECTION STRATEGY

The way to handled values when collecting them: static means we keep the last known value, rrd means we store values in a buffer from which you can retrieve the average

Path: /settings/system/windows/counters/sample

Key: collection strategy

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# COLLECTION STRATEGY
collection strategy=
counter (CheckSystem, /settings/system/windows/counters/sample)

COUNTER

The counter to check

Path: /settings/system/windows/counters/sample

Key: counter

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# COUNTER
counter=
flags (CheckSystem, /settings/system/windows/counters/sample)

FLAGS

Extra flags to configure the counter (nocap100, 1000, noscale)

Path: /settings/system/windows/counters/sample

Key: flags

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# FLAGS
flags=
instances (CheckSystem, /settings/system/windows/counters/sample)

Interpret instances

IF we shoul interpret instance (default auto). Values: auto, true, false

Path: /settings/system/windows/counters/sample

Key: instances

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# Interpret instances
instances=
is template (CheckSystem, /settings/system/windows/counters/sample)

IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/system/windows/counters/sample

Key: is template

Default value: 0

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# IS TEMPLATE
is template=0
parent (CheckSystem, /settings/system/windows/counters/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/system/windows/counters/sample

Key: parent

Default value: default

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# PARENT
parent=default
type (CheckSystem, /settings/system/windows/counters/sample)

COUNTER TYPE

The type of counter to use long, large and double

Path: /settings/system/windows/counters/sample

Key: type

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: CheckSystem

Sample:

[/settings/system/windows/counters/sample]
# COUNTER TYPE
type=

… / real-time

/settings/system/windows/real-time (CheckSystem)

CONFIGURE REALTIME CHECKING

A set of options to configure the real time checks

Sample:

# CONFIGURE REALTIME CHECKING
# A set of options to configure the real time checks
[/settings/system/windows/real-time]

… / real-time / checks

/settings/system/windows/real-time/checks (CheckSystem)

REALTIME FILTERS

A set of filters to use in real-time mode

Sample:

# REALTIME FILTERS
# A set of filters to use in real-time mode
[/settings/system/windows/real-time/checks]

… / service mapping

/settings/system/windows/service mapping (CheckSystem)

SERVICE MAPPING SECTION

Configure which services has to be in which state

Sample:

# SERVICE MAPPING SECTION
# Configure which services has to be in which state
[/settings/system/windows/service mapping]
comments powered by Disqus