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 avalible 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_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.
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:

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

Alias Command Description
check_counter check_pdh check_counter

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/default cache allowed hosts 1 CACHE ALLOWED HOSTS
/settings/default bind to   BIND TO ADDRESS
/settings/default allowed hosts 127.0.0.1 ALLOWED HOSTS
/settings/default inbox inbox INBOX
/settings/default timeout 30 TIMEOUT
/settings/default password   PASSWORD
/settings/system/windows default buffer length 1h DEFAULT LENGTH
/settings/system/windows/counters     COUNTERS
/settings/system/windows/real-time     CONFIGURE REALTIME CHECKING
/settings/system/windows/real-time/checks     REALTIME FILTERS
/settings/system/windows/service mapping     SERVICE MAPPING SECTION

Advanced keys:

Path / Section Key Default value Description
/settings/default socket queue size 0 LISTEN QUEUE
/settings/default encoding   NRPE PAYLOAD ENCODING
/settings/default thread pool 10 THREAD POOL
/settings/default modern commands 1 Register modern aliases for built-in commands
/settings/system/windows subsystem default PDH SUBSYSTEM
/settings/system/windows modern commands 1 Register modern aliases for built-in commands

Sample keys:

Path / Section Key Default value Description
/settings/system/windows/real-time/checks/sample top syntax   SYNTAX
/settings/system/windows/real-time/checks/sample perf config   PERF CONFIG
/settings/system/windows/real-time/checks/sample empty message eventlog found no records EMPTY MESSAGE
/settings/system/windows/real-time/checks/sample ok   OK FILTER
/settings/system/windows/real-time/checks/sample severity   SEVERITY
/settings/system/windows/real-time/checks/sample parent default PARENT
/settings/system/windows/real-time/checks/sample destination   DESTINATION
/settings/system/windows/real-time/checks/sample maximum age 5m MAGIMUM AGE
/settings/system/windows/real-time/checks/sample is template 0 IS TEMPLATE
/settings/system/windows/real-time/checks/sample filter   FILTER
/settings/system/windows/real-time/checks/sample alias   ALIAS
/settings/system/windows/real-time/checks/sample critical   CRITCAL FILTER
/settings/system/windows/real-time/checks/sample command   COMMAND NAME
/settings/system/windows/real-time/checks/sample detail syntax   SYNTAX
/settings/system/windows/real-time/checks/sample time   TIME
/settings/system/windows/real-time/checks/sample debug 0 DEBUG
/settings/system/windows/real-time/checks/sample times   FILES
/settings/system/windows/real-time/checks/sample warning   WARNING FILTER
/settings/system/windows/real-time/checks/sample check cpu TYPE OF CHECK
/settings/system/windows/real-time/checks/sample target   DESTINATION

Queries

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

checkservicestate

CheckSystemcheckservicestate
Legacy version of check_service

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
CheckAll true Check all services.
exclude N/A 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-csv (CheckSystem, checkservicestate)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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).

check_uptime

CheckSystemcheck_uptime
Check time since last server re-boot.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax Uptime ok Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${list} Top level syntax.
detail-syntax uptime: ${uptime}h, boot: ${boot} (UTC) Detail level syntax.
perf-syntax uptime Performance alias syntax.

Arguments

help (CheckSystem, check_uptime)
Show help screen (this screen)
help-csv (CheckSystem, check_uptime)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_uptime)
Show help screen (short format).
debug (CheckSystem, check_uptime)
Show debugging information in the log
show-all (CheckSystem, check_uptime)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
Key Value
boot System boot time
uptime Time since last boot
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
boot System boot time
uptime Time since last boot
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
boot System boot time
uptime Time since last boot
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
boot System boot time
uptime Time since last boot
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_uptime)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_uptime)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
Key Value
%(boot) System boot time
%(uptime) Time since last boot
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_uptime)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
Possible values are:
Key Value
%(boot) System boot time
%(uptime) Time since last boot
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

check_os_version

CheckSystemcheck_os_version
Check the version of the underlaying OS.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax Version ok Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${list} Top level syntax.
detail-syntax ${version} (${major}.${minor}.${build}) Detail level syntax.
perf-syntax version Performance alias syntax.

Arguments

help (CheckSystem, check_os_version)
Show help screen (this screen)
help-csv (CheckSystem, check_os_version)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_os_version)
Show help screen (short format).
debug (CheckSystem, check_os_version)
Show debugging information in the log
show-all (CheckSystem, check_os_version)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
Key Value
build Build version number
major Major version number
minor Minor version number
version The system version
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
build Build version number
major Major version number
minor Minor version number
version The system version
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
build Build version number
major Major version number
minor Minor version number
version The system version
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
build Build version number
major Major version number
minor Minor version number
version The system version
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_os_version)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_os_version)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
Key Value
%(build) Build version number
%(major) Major version number
%(minor) Minor version number
%(version) The system version
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_os_version)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
Possible values are:
Key Value
%(build) Build version number
%(major) Major version number
%(minor) Minor version number
%(version) The system version
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

checkcpu

CheckSystemcheckcpu
Legacy version of check_cpu

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
time N/A 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 N/A Maximum value before a warning is returned.
MaxCrit N/A Maximum value before a critical is returned.
MinWarn N/A Minimum value before a warning is returned.
MinCrit N/A Minimum value before a critical is returned.
warn N/A Maximum value before a warning is returned.
crit N/A Maximum value before a critical is returned.

Arguments

help (CheckSystem, checkcpu)
Show help screen (this screen)
help-csv (CheckSystem, checkcpu)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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.

checkcounter

CheckSystemcheckcounter
Legacy version of check_pdh

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
Counter N/A 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 N/A Maximum value before a warning is returned.
MaxCrit N/A Maximum value before a critical is returned.
MinWarn N/A Minimum value before a warning is returned.
MinCrit N/A Minimum value before a critical is returned.

Arguments

help (CheckSystem, checkcounter)
Show help screen (this screen)
help-csv (CheckSystem, checkcounter)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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.

checkprocstate

CheckSystemcheckprocstate
Legacy version of check_process

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
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 N/A Maximum value before a warning is returned.
MaxCritCount N/A Maximum value before a critical is returned.
MinWarnCount N/A Minimum value before a warning is returned.
MinCritCount N/A Minimum value before a critical is returned.

Arguments

help (CheckSystem, checkprocstate)
Show help screen (this screen)
help-csv (CheckSystem, checkprocstate)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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.

check_cpu

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

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax CPU Load ok Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${problem_list} Top level syntax.
detail-syntax ${time}: ${load}% Detail level syntax.
perf-syntax ${core} ${time} Performance alias syntax.
time N/A The time to check

Arguments

help (CheckSystem, check_cpu)
Show help screen (this screen)
help-csv (CheckSystem, check_cpu)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_cpu)
Show help screen (short format).
debug (CheckSystem, check_cpu)
Show debugging information in the log
show-all (CheckSystem, check_cpu)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_cpu)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_cpu)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_cpu)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

time (CheckSystem, check_cpu)
The time to check

checkmem

CheckSystemcheckmem
Legacy version of check_mem

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
type N/A 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 N/A Maximum value before a warning is returned.
MaxCrit N/A Maximum value before a critical is returned.
MinWarn N/A Minimum value before a warning is returned.
MinCrit N/A Minimum value before a critical is returned.
warn N/A Maximum value before a warning is returned.
crit N/A Maximum value before a critical is returned.

Arguments

help (CheckSystem, checkmem)
Show help screen (this screen)
help-csv (CheckSystem, checkmem)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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.

checkuptime

CheckSystemcheckuptime
Legacy version of check_uptime

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
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 N/A Maximum value before a warning is returned.
MaxCrit N/A Maximum value before a critical is returned.
MinWarn N/A Minimum value before a warning is returned.
MinCrit N/A Minimum value before a critical is returned.
warn N/A Maximum value before a warning is returned.
crit N/A Maximum value before a critical is returned.

Arguments

help (CheckSystem, checkuptime)
Show help screen (this screen)
help-csv (CheckSystem, checkuptime)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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.

check_pdh

CheckSystemcheck_pdh
Check the value of a performance (PDH) counter.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax Everything looks good Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${problem_list} Top level syntax.
detail-syntax ${counter} = ${value} Detail level syntax.
perf-syntax ${alias} Performance alias syntax.
counter N/A 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 N/A Timeframe to use for named rrd counters
flags N/A Extra flags to configure the counter (nocap100, 1000, noscale)
type large Format of value (double, long, large)

Arguments

help (CheckSystem, check_pdh)
Show help screen (this screen)
help-csv (CheckSystem, check_pdh)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_pdh)
Show help screen (short format).
debug (CheckSystem, check_pdh)
Show debugging information in the log
show-all (CheckSystem, check_pdh)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
Key Value
alias The counter alias
counter The counter name
value The counter value
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
alias The counter alias
counter The counter name
value The counter value
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
alias The counter alias
counter The counter name
value The counter value
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
alias The counter alias
counter The counter name
value The counter value
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_pdh)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_pdh)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
Key Value
%(alias) The counter alias
%(counter) The counter name
%(value) The counter value
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_pdh)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
Possible values are:
Key Value
%(alias) The counter alias
%(counter) The counter name
%(value) The counter value
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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
%(value) The counter value
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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_service

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

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax OK all services are ok. Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${crit_list}, delayed (${warn_list}) Top level syntax.
detail-syntax ${name}=${state} (${start_type}) Detail level syntax.
perf-syntax ${name} Performance alias syntax.
computer N/A THe name of the remote computer to check
service N/A The service to check, set this to * to check all services
exclude N/A 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

Arguments

help (CheckSystem, check_service)
Show help screen (this screen)
help-csv (CheckSystem, check_service)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_service)
Show help screen (short format).
debug (CheckSystem, check_service)
Show debugging information in the log
show-all (CheckSystem, check_service)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
Key Value
delayed If the service is delayed
desc Service description
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 ()
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
delayed If the service is delayed
desc Service description
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 ()
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
delayed If the service is delayed
desc Service description
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 ()
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
delayed If the service is delayed
desc Service description
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 ()
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_service)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_service)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
Key Value
%(delayed) If the service is delayed
%(desc) Service description
%(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 ()
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_service)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
Possible values are:
Key Value
%(delayed) If the service is delayed
%(desc) Service description
%(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 ()
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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
%(delayed) If the service is delayed
%(desc) Service description
%(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 ()
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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

check_memory

CheckSystemcheck_memory
Check free/used memory on the system.

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax OK memory within bounds. Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${problem_list} Top level syntax.
detail-syntax ${type} = ${used} Detail level syntax.
perf-syntax ${type} Performance alias syntax.
type N/A The type of memory to check (physical = Physical memory (RAM), committed = total memory (RAM+PAGE)

Arguments

help (CheckSystem, check_memory)
Show help screen (this screen)
help-csv (CheckSystem, check_memory)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_memory)
Show help screen (short format).
debug (CheckSystem, check_memory)
Show debugging information in the log
show-all (CheckSystem, check_memory)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
size Total size of memory
type The type of memory to check
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
size Total size of memory
type The type of memory to check
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
size Total size of memory
type The type of memory to check
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
free Free memory in bytes (g,m,k,b) or percentages %
size Total size of memory
type The type of memory to check
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_memory)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_memory)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
Key Value
%(free) Free memory in bytes (g,m,k,b) or percentages %
%(size) Total size of memory
%(type) The type of memory to check
%(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
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_memory)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
Possible values are:
Key Value
%(free) Free memory in bytes (g,m,k,b) or percentages %
%(size) Total size of memory
%(type) The type of memory to check
%(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
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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 %
%(size) Total size of memory
%(type) The type of memory to check
%(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
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

type (CheckSystem, check_memory)
The type of memory to check (physical = Physical memory (RAM), committed = total memory (RAM+PAGE)

check_process

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

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax OK all processes are ok. Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${problem_list} Top level syntax.
detail-syntax ${exe}=${state} Detail level syntax.
perf-syntax ${exe} Performance alias syntax.
process N/A The service to check, set this to * to check all services
scan-info N/A If all process metrics should be fetched (otherwise only status is fetched)
scan-16bit N/A If 16bit processes should be included
delta N/A Calculate delta over one elapsed second.
scan-unreadable N/A If unreadable processes should be included (will not have information)

Arguments

help (CheckSystem, check_process)
Show help screen (this screen)
help-csv (CheckSystem, check_process)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_process)
Show help screen (short format).
debug (CheckSystem, check_process)
Show debugging information in the log
show-all (CheckSystem, check_process)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
Key Value
command_line Command line of process (not always available)
creation Creation time
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
command_line Command line of process (not always available)
creation Creation time
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
command_line Command line of process (not always available)
creation Creation time
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
command_line Command line of process (not always available)
creation Creation time
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
count Number of items matching the filter
total Total number of items
ok_count Number of items matched the ok criteria
warn_count Number of items matched the warning criteria
crit_count Number of items matched the critical criteria
problem_count Number of items matched either warning or critical criteria
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_process)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_process)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
Key Value
%(command_line) Command line of process (not always available)
%(creation) Creation time
%(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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_process)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
Possible values are:
Key Value
%(command_line) Command line of process (not always available)
%(creation) Creation time
%(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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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
%(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
${count} Number of items matching the filter
${total} Total number of items
${ok_count} Number of items matched the ok criteria
${warn_count} Number of items matched the warning criteria
${crit_count} Number of items matched the critical criteria
${problem_count} Number of items matched either warning or critical criteria
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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 mesure values and then sleep for 2 second and then measure again caluclating deltas.
scan-unreadable (CheckSystem, check_process)
If unreadable processes should be included (will not have information)

check_pagefile

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

Usage:

Option Default value Description
help N/A Show help screen (this screen)
help-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
debug N/A Show debugging information in the log
show-all N/A Show debugging information in the log
filter N/A Filter which marks interesting items.
warning N/A Filter which marks items which generates a warning state.
warn N/A Short alias for warning
critical N/A Filter which marks items which generates a critical state.
crit N/A Short alias for critical.
ok N/A Filter which marks items which generates an ok state.
empty-syntax OK pagefile within bounds. Message to display when nothing matched filter.
empty-state unknown Return status to use when nothing matched filter.
perf-config N/A Performance data generation configuration
top-syntax ${status}: ${problem_list} Top level syntax.
detail-syntax ${name} ${used} (${size}) Detail level syntax.
perf-syntax ${name} Performance alias syntax.

Arguments

help (CheckSystem, check_pagefile)
Show help screen (this screen)
help-csv (CheckSystem, check_pagefile)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
help-short (CheckSystem, check_pagefile)
Show help screen (short format).
debug (CheckSystem, check_pagefile)
Show debugging information in the log
show-all (CheckSystem, check_pagefile)
Show debugging information in the log
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 but they are checked use this to filter out unwanted items.
Avalible options:
Key Value
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


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.
Avalible options:
Key Value
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
list A list of all items which matched the filter
ok_list A list of all items which matched the ok criteria
warn_list A list of all items which matched the warning criteria
crit_list A list of all items which matched the critical criteria
problem_list A list of all items which matched either the critical or the warning criteria
status The returned status (OK/WARN/CRIT/UNKNOWN)


empty-syntax (CheckSystem, check_pagefile)
Message to display when nothing matched filter.
If no filter is specified this will never happen unless the file is empty.
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)
top-syntax (CheckSystem, check_pagefile)
Top level syntax.
Used to format the message to return can include strings as well as special keywords such as:
Key Value
%(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
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

detail-syntax (CheckSystem, check_pagefile)
Detail level syntax.
This is the syntax of each item in the list of top-syntax (see above).
Possible values are:
Key Value
%(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
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

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 %
%(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
${list} A list of all items which matched the filter
${ok_list} A list of all items which matched the ok criteria
${warn_list} A list of all items which matched the warning criteria
${crit_list} A list of all items which matched the critical criteria
${problem_list} A list of all items which matched either the critical or the warning criteria
${status} The returned status (OK/WARN/CRIT/UNKNOWN)

Configuration

A quick reference for all avalible configuration options in the CheckSystem module.

... / settings / default

/settings/default (CheckSystem)
Key Default Value Description
allowed hosts 127.0.0.1 ALLOWED HOSTS
bind to   BIND TO ADDRESS
cache allowed hosts 1 CACHE ALLOWED HOSTS
inbox inbox INBOX
password   PASSWORD
timeout 30 TIMEOUT
encoding   NRPE PAYLOAD ENCODING
modern commands 1 Register modern aliases for built-in commands
socket queue size 0 LISTEN QUEUE
thread pool 10 THREAD POOL

Sample:

#
#
[/settings/default]
# CACHE ALLOWED HOSTS
# If host names (DNS entries) should be cached, improves speed and security somewhat but won't allow you to have dynamic IPs for your Nagios server.
cache allowed hosts=1
# LISTEN QUEUE
# Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts.
socket queue size=0
# NRPE PAYLOAD ENCODING
#
encoding=
# BIND TO ADDRESS
# Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses.
bind to=
# ALLOWED HOSTS
# A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.
allowed hosts=127.0.0.1
# THREAD POOL
#
thread pool=10
# INBOX
# The default channel to post incoming messages on
inbox=inbox
# TIMEOUT
# Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.
timeout=30
# PASSWORD
# Password to use
password=
# Register modern aliases for built-in commands
# Register modern alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++
modern commands=1
cache allowed hosts (CheckSystem, /settings/default)

CACHE ALLOWED HOSTS

If host names (DNS entries) should be cached, improves speed and security somewhat but won’t allow you to have dynamic IPs for your Nagios server.

Path: /settings/default

Key: cache allowed hosts

Default value: 1

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# CACHE ALLOWED HOSTS
# If host names (DNS entries) should be cached, improves speed and security somewhat but won't allow you to have dynamic IPs for your Nagios server.
[/settings/default]
cache allowed hosts=1
socket queue size (CheckSystem, /settings/default)

LISTEN QUEUE

Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts.

Advanced (means it is not commonly used)

Path: /settings/default

Key: socket queue size

Default value: 0

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# LISTEN QUEUE
# Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts.
[/settings/default]
socket queue size=0
encoding (CheckSystem, /settings/default)

NRPE PAYLOAD ENCODING


Advanced (means it is not commonly used)

Path: /settings/default

Key: encoding

Default value:

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# NRPE PAYLOAD ENCODING
#
[/settings/default]
encoding=
bind to (CheckSystem, /settings/default)

BIND TO ADDRESS

Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses.

Path: /settings/default

Key: bind to

Default value:

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# BIND TO ADDRESS
# Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses.
[/settings/default]
bind to=
allowed hosts (CheckSystem, /settings/default)

ALLOWED HOSTS

A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.

Path: /settings/default

Key: allowed hosts

Default value: 127.0.0.1

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# ALLOWED HOSTS
# A comaseparated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.
[/settings/default]
allowed hosts=127.0.0.1
thread pool (CheckSystem, /settings/default)

THREAD POOL


Advanced (means it is not commonly used)

Path: /settings/default

Key: thread pool

Default value: 10

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# THREAD POOL
#
[/settings/default]
thread pool=10
inbox (CheckSystem, /settings/default)

INBOX

The default channel to post incoming messages on

Path: /settings/default

Key: inbox

Default value: inbox

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# INBOX
# The default channel to post incoming messages on
[/settings/default]
inbox=inbox
timeout (CheckSystem, /settings/default)

TIMEOUT

Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.

Path: /settings/default

Key: timeout

Default value: 30

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# TIMEOUT
# Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.
[/settings/default]
timeout=30
password (CheckSystem, /settings/default)

PASSWORD

Password to use

Path: /settings/default

Key: password

Default value:

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# PASSWORD
# Password to use
[/settings/default]
password=
modern commands (CheckSystem, /settings/default)

Register modern aliases for built-in commands

Register modern alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++

Advanced (means it is not commonly used)

Path: /settings/default

Key: modern commands

Default value: 1

Used by: CheckMKServer, CheckSystem, NRPEServer, NSCAServer, NSClientServer, NSCPServer

Sample:

# Register modern aliases for built-in commands
# Register modern alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++
[/settings/default]
modern commands=1

... / settings / system / windows / service mapping

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

Sample:

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

... / settings / system / windows / real-time / checks

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

Sample:

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

... / settings / system / windows / counters

/settings/system/windows/counters (CheckSystem)

Sample:

# COUNTERS
# Add counters to check
[/settings/system/windows/counters]

... / settings / system / windows / real-time

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

Sample:

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

... / settings / system / windows

/settings/system/windows (CheckSystem)
Key Default Value Description
default buffer length 1h DEFAULT LENGTH
modern commands 1 Register modern aliases for built-in commands
subsystem default PDH SUBSYSTEM

Sample:

# WINDOWS CHECK SYSTEM
# Section for system checks and system settings
[/settings/system/windows]
# DEFAULT LENGTH
# Used to define the default interval for range buffer checks (ie. CPU).
default buffer length=1h
# PDH SUBSYSTEM
# Set which pdh subsystem to use.
subsystem=default
# Register modern aliases for built-in commands
# Register modern alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
modern commands=1
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:

# DEFAULT LENGTH
# Used to define the default interval for range buffer checks (ie. CPU).
[/settings/system/windows]
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:

# PDH SUBSYSTEM
# Set which pdh subsystem to use.
[/settings/system/windows]
subsystem=default
modern commands (CheckSystem, /settings/system/windows)

Register modern aliases for built-in commands

Register modern alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.

Advanced (means it is not commonly used)

Path: /settings/system/windows

Key: modern commands

Default value: 1

Used by: CheckSystem

Sample:

# Register modern aliases for built-in commands
# Register modern alias for commands (ccheck_xxx as opposed of CheckXXX) these are the names which will be used in future version of NSClient++ parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.
[/settings/system/windows]
modern commands=1

... / settings / system / windows / real-time / checks / sample

/settings/system/windows/real-time/checks/sample (CheckSystem)
Key Default Value Description
alias   ALIAS
check cpu TYPE OF CHECK
command   COMMAND NAME
critical   CRITCAL FILTER
debug 0 DEBUG
destination   DESTINATION
detail syntax   SYNTAX
empty message eventlog found no records EMPTY MESSAGE
filter   FILTER
is template 0 IS TEMPLATE
maximum age 5m MAGIMUM AGE
ok   OK FILTER
parent default PARENT
perf config   PERF CONFIG
severity   SEVERITY
target   DESTINATION
time   TIME
times   FILES
top syntax   SYNTAX
warning   WARNING FILTER

Sample:

# REAL TIME FILTER DEFENITION
# Definition for real time filter: sample
[/settings/system/windows/real-time/checks/sample]
# SYNTAX
# Format string for dates
top syntax=
# PERF CONFIG
# Performance data configuration
perf config=
# EMPTY MESSAGE
# The message to display if nothing matches the filter (generally considered the ok state).
empty message=eventlog found no records
# OK FILTER
# If any rows match this filter severity will escalated down to OK
ok=
# SEVERITY
# THe severity of this message (OK, WARNING, CRITICAL, UNKNOWN)
severity=
# PARENT
# The parent the target inherits from
parent=default
# DESTINATION
# The destination for intercepted messages
destination=
# MAGIMUM AGE
# How long before reporting "ok".
maximum age=5m
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
# FILTER
# Scan files for matching rows for each matching rows an OK message will be submitted
filter=
# ALIAS
# The alias (service name) to report to server
alias=
# CRITCAL FILTER
# If any rows match this filter severity will escalated to CRITCAL
critical=
# COMMAND NAME
# The name of the command (think nagios service name) to report up stream (defaults to alias if not set)
command=
# SYNTAX
# Format string for dates
detail syntax=
# TIME
# The time to check
time=
# DEBUG
# Enable this to display debug information for this match filter
debug=0
# FILES
# A list of times to check (soma separated)
times=
# WARNING FILTER
# If any rows match this filter severity will escalated to WARNING
warning=
# TYPE OF CHECK
# The type of check cpu or memory
check=cpu
# DESTINATION
# Same as destination
target=
top syntax (CheckSystem, /settings/system/windows/real-time/checks/sample)

SYNTAX

Format string for dates

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: top syntax

Default value:

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

Used by: CheckSystem

Sample:

# SYNTAX
# Format string for dates
[/settings/system/windows/real-time/checks/sample]
top syntax=
perf config (CheckSystem, /settings/system/windows/real-time/checks/sample)

PERF CONFIG

Performance data configuration

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: perf config

Default value:

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

Used by: CheckSystem

Sample:

# PERF CONFIG
# Performance data configuration
[/settings/system/windows/real-time/checks/sample]
perf config=
empty message (CheckSystem, /settings/system/windows/real-time/checks/sample)

EMPTY MESSAGE

The message to display if nothing matches the filter (generally considered the ok state).

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: empty message

Default value: eventlog found no records

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

Used by: CheckSystem

Sample:

# EMPTY MESSAGE
# The message to display if nothing matches the filter (generally considered the ok state).
[/settings/system/windows/real-time/checks/sample]
empty message=eventlog found no records
ok (CheckSystem, /settings/system/windows/real-time/checks/sample)

OK FILTER

If any rows match this filter severity will escalated down to OK

Path: /settings/system/windows/real-time/checks/sample

Key: ok

Default value:

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

Used by: CheckSystem

Sample:

# OK FILTER
# If any rows match this filter severity will escalated down to OK
[/settings/system/windows/real-time/checks/sample]
ok=
severity (CheckSystem, /settings/system/windows/real-time/checks/sample)

SEVERITY

THe severity of this message (OK, WARNING, CRITICAL, UNKNOWN)

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: severity

Default value:

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

Used by: CheckSystem

Sample:

# SEVERITY
# THe severity of this message (OK, WARNING, CRITICAL, UNKNOWN)
[/settings/system/windows/real-time/checks/sample]
severity=
parent (CheckSystem, /settings/system/windows/real-time/checks/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: parent

Default value: default

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

Used by: CheckSystem

Sample:

# PARENT
# The parent the target inherits from
[/settings/system/windows/real-time/checks/sample]
parent=default
destination (CheckSystem, /settings/system/windows/real-time/checks/sample)

DESTINATION

The destination for intercepted messages

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: destination

Default value:

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

Used by: CheckSystem

Sample:

# DESTINATION
# The destination for intercepted messages
[/settings/system/windows/real-time/checks/sample]
destination=
maximum age (CheckSystem, /settings/system/windows/real-time/checks/sample)

MAGIMUM AGE

How long before reporting “ok”.
If this is set to “false” no periodic ok messages will be reported only errors.

Path: /settings/system/windows/real-time/checks/sample

Key: maximum age

Default value: 5m

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

Used by: CheckSystem

Sample:

# MAGIMUM AGE
# How long before reporting "ok".
[/settings/system/windows/real-time/checks/sample]
maximum age=5m
is template (CheckSystem, /settings/system/windows/real-time/checks/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/real-time/checks/sample

Key: is template

Default value: 0

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

Used by: CheckSystem

Sample:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/system/windows/real-time/checks/sample]
is template=0
filter (CheckSystem, /settings/system/windows/real-time/checks/sample)

FILTER

Scan files for matching rows for each matching rows an OK message will be submitted

Path: /settings/system/windows/real-time/checks/sample

Key: filter

Default value:

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

Used by: CheckSystem

Sample:

# FILTER
# Scan files for matching rows for each matching rows an OK message will be submitted
[/settings/system/windows/real-time/checks/sample]
filter=
alias (CheckSystem, /settings/system/windows/real-time/checks/sample)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: alias

Default value:

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

Used by: CheckSystem

Sample:

# ALIAS
# The alias (service name) to report to server
[/settings/system/windows/real-time/checks/sample]
alias=
critical (CheckSystem, /settings/system/windows/real-time/checks/sample)

CRITCAL FILTER

If any rows match this filter severity will escalated to CRITCAL

Path: /settings/system/windows/real-time/checks/sample

Key: critical

Default value:

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

Used by: CheckSystem

Sample:

# CRITCAL FILTER
# If any rows match this filter severity will escalated to CRITCAL
[/settings/system/windows/real-time/checks/sample]
critical=
command (CheckSystem, /settings/system/windows/real-time/checks/sample)

COMMAND NAME

The name of the command (think nagios service name) to report up stream (defaults to alias if not set)

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: command

Default value:

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

Used by: CheckSystem

Sample:

# COMMAND NAME
# The name of the command (think nagios service name) to report up stream (defaults to alias if not set)
[/settings/system/windows/real-time/checks/sample]
command=
detail syntax (CheckSystem, /settings/system/windows/real-time/checks/sample)

SYNTAX

Format string for dates

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: detail syntax

Default value:

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

Used by: CheckSystem

Sample:

# SYNTAX
# Format string for dates
[/settings/system/windows/real-time/checks/sample]
detail syntax=
time (CheckSystem, /settings/system/windows/real-time/checks/sample)

TIME

The time to check

Path: /settings/system/windows/real-time/checks/sample

Key: time

Default value:

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

Used by: CheckSystem

Sample:

# TIME
# The time to check
[/settings/system/windows/real-time/checks/sample]
time=
debug (CheckSystem, /settings/system/windows/real-time/checks/sample)

DEBUG

Enable this to display debug information for this match filter

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: debug

Default value: 0

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

Used by: CheckSystem

Sample:

# DEBUG
# Enable this to display debug information for this match filter
[/settings/system/windows/real-time/checks/sample]
debug=0
times (CheckSystem, /settings/system/windows/real-time/checks/sample)

FILES

A list of times to check (soma separated)

Advanced (means it is not commonly used)

Path: /settings/system/windows/real-time/checks/sample

Key: times

Default value:

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

Used by: CheckSystem

Sample:

# FILES
# A list of times to check (soma separated)
[/settings/system/windows/real-time/checks/sample]
times=
warning (CheckSystem, /settings/system/windows/real-time/checks/sample)

WARNING FILTER

If any rows match this filter severity will escalated to WARNING

Path: /settings/system/windows/real-time/checks/sample

Key: warning

Default value:

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

Used by: CheckSystem

Sample:

# WARNING FILTER
# If any rows match this filter severity will escalated to WARNING
[/settings/system/windows/real-time/checks/sample]
warning=
check (CheckSystem, /settings/system/windows/real-time/checks/sample)

TYPE OF CHECK

The type of check cpu or memory

Path: /settings/system/windows/real-time/checks/sample

Key: check

Default value: cpu

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

Used by: CheckSystem

Sample:

# TYPE OF CHECK
# The type of check cpu or memory
[/settings/system/windows/real-time/checks/sample]
check=cpu
target (CheckSystem, /settings/system/windows/real-time/checks/sample)

DESTINATION

Same as destination

Path: /settings/system/windows/real-time/checks/sample

Key: target

Default value:

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

Used by: CheckSystem

Sample:

# DESTINATION
# Same as destination
[/settings/system/windows/real-time/checks/sample]
target=
comments powered by Disqus