CheckNSCP
Use this module to check the health and status of NSClient++ it self
Enable module
To enable this module and and allow using the commands you need to ass CheckNSCP = enabled
to the [/modules]
section in nsclient.ini:
[/modules]
CheckNSCP = enabled
Queries
A quick reference for all available queries (check commands) in the CheckNSCP module.
List of commands:
A list of all available queries (check commands)
Command | Description |
---|---|
check_nscp | Check the internal health of NSClient++. |
check_nscp_version | Check the version of NSClient++ which is used. |
check_nscp
Check the internal health of NSClient++.
Command-line Arguments
Option | Default Value | Description |
---|---|---|
help | N/A | Show help screen (this screen) |
help-pb | N/A | Show help screen as a protocol buffer payload |
show-default | N/A | Show default values for a given command |
help-short | N/A | Show help screen (short format). |
check_nscp_version
Check the version of NSClient++ which is used.
Command-line Arguments
Option | Default Value | Description |
---|---|---|
filter | Filter which marks interesting items. | |
warning | Filter which marks items which generates a warning state. | |
warn | Short alias for warning | |
critical | Filter which marks items which generates a critical state. | |
crit | Short alias for critical. | |
ok | Filter which marks items which generates an ok state. | |
debug | N/A | Show debugging information in the log |
show-all | N/A | Show details for all matches regardless of status (normally details are only showed for warnings and criticals). |
empty-state | ignored | Return status to use when nothing matched filter. |
perf-config | Performance data generation configuration | |
escape-html | N/A | Escape any < and > characters to prevent HTML encoding |
help | N/A | Show help screen (this screen) |
help-pb | N/A | Show help screen as a protocol buffer payload |
show-default | N/A | Show default values for a given command |
help-short | N/A | Show help screen (short format). |
top-syntax | ${status}: ${list} | Top level syntax. |
ok-syntax | ok syntax. | |
empty-syntax | Empty syntax. | |
detail-syntax | ${version} (${date}) | Detail level syntax. |
perf-syntax | version | Performance alias syntax. |
filter:
Filter which marks interesting items. Interesting items are items which will be included in the check. They do not denote warning or critical state instead it defines which items are relevant and you can remove unwanted items.
warning:
Filter which marks items which generates a warning state. If anything matches this filter the return status will be escalated to warning.
critical:
Filter which marks items which generates a critical state. If anything matches this filter the return status will be escalated to critical.
ok:
Filter which marks items which generates an ok state. If anything matches this any previous state for this item will be reset to ok.
empty-state:
Return status to use when nothing matched filter. If no filter is specified this will never happen unless the file is empty.
Default Value: ignored
perf-config:
Performance data generation configuration TODO: obj ( key: value; key: value) obj (key:valuer;key:value)
top-syntax:
Top level syntax. Used to format the message to return can include text as well as special keywords which will include information from the checks. To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to escape on linux).
Default Value: ${status}: ${list}
ok-syntax:
ok syntax. DEPRECATED! This is the syntax for when an ok result is returned. This value will not be used if your syntax contains %(list) or %(count).
empty-syntax:
Empty syntax. DEPRECATED! This is the syntax for when nothing matches the filter.
detail-syntax:
Detail level syntax. Used to format each resulting item in the message. %(list) will be replaced with all the items formated by this syntax string in the top-syntax. To add a keyword to the message you can use two syntaxes either ${keyword} or %(keyword) (there is no difference between them apart from ${} can be difficult to escape on linux).
Default Value: ${version} (${date})
perf-syntax:
Performance alias syntax. This is the syntax for the base names of the performance data.
Default Value: version
Filter keywords
Option | Description |
---|---|
build | The build (the 3 in 0.1.2.3) not available in release versions after 0.6.0 |
count | Number of items matching the filter. Common option for all checks. |
crit_count | Number of items matched the critical criteria. Common option for all checks. |
crit_list | A list of all items which matched the critical criteria. Common option for all checks. |
date | The NSClient++ Build date |
detail_list | A special list with critical, then warning and finally ok. Common option for all checks. |
list | A list of all items which matched the filter. Common option for all checks. |
major | The major (the 1 in 0.1.2.3) |
minor | The minor (the 2 in 0.1.2.3) |
ok_count | Number of items matched the ok criteria. Common option for all checks. |
ok_list | A list of all items which matched the ok criteria. Common option for all checks. |
problem_count | Number of items matched either warning or critical criteria. Common option for all checks. |
problem_list | A list of all items which matched either the critical or the warning criteria. Common option for all checks. |
release | The release (the 0 in 0.1.2.3) |
status | The returned status (OK/WARN/CRIT/UNKNOWN). Common option for all checks. |
total | Total number of items. Common option for all checks. |
version | The NSClient++ Version as a string |
warn_count | Number of items matched the warning criteria. Common option for all checks. |
warn_list | A list of all items which matched the warning criteria. Common option for all checks. |