Modules

NSClient++ comes with a few modules out of the box that perform various checks. A list of the modules and their potential use is listed below. Click each plug-in to see detailed command descriptions and how the various modules can be used.

CheckDisk

Module to do various disk related checks.

• CheckFileSize, Check the size of a file
• CheckDriveSize, Check the size of a fixed drive or mounted volume
• CheckFile, Check various aspects on one or more files or directories.

CheckEventLog

Module to check event log

• CheckEventLog, Check event log for errors

CheckSystem

Module to check system related things

• CheckCPU, Check CPU load averages
• CheckUpTime, Check system uptime
• CheckServiceState, Check State of a service
• CheckProcState, Check state of a process (application)
• CheckMem, Check state of memory (Page file)
• CheckCounter, Check performance counters

CheckHelpers

Various helper function, doesn't check anything in it self but can help make things simpler.

• CheckAlwaysOK, Runs another check and always returns OK regardless of result.
• CheckAlwaysCRITICAL, Runs another check and always returns CRITICAL regardless of result.
• CheckAlwaysWARNING, Runs another check and always returns WARNING regardless of result.
• CheckMultiple, Runs multiple checks and returns them all in one go.
• CheckOK, Always returns OK (useful for NSCA)
• CheckCRITICAL, Always returns CRITICAL (useful for NSCA)
• CheckWARNING, Always returns WARNING (useful for NSCA)
• CheckVersion, Returns the version of NSClient++

FileLogger

Logs all messages (errors, warnings etc) to a file.

NRPEListener

Listens for incoming NRPE calls and handles them by injecting them into the core. It also listens for all NRPE definitions and executes them

NSClientListener

Listens for incoming NSClient calls and handles them accordingly. This only allows a limited subset of functionality and NRPE is recommended.

SysTray

A simple module to show an icon in the tray when the service is running this module does not export any check commands.

CheckWMI

• CheckWMI, Check large resultsets from (for instance are there more then 5-rows matching criteria X, ie. more than 5 internet explorer processes which uses more than 123Mb memory).
• CheckWMIValue, Check the result of a query (ie. are the current memory utilization over X)

CheckTaskSched

• CheckTaskSched, Check if scheduled tasks are working/scheduled/*.

CheckExternalScripts

User defined check commands, allows writing check scripts in external languages (VB, batch, EXE, *).

LUAScript

User defined check commands, allows writing check scripts (and wrap others in) the Lua scripting language.

NSCAAgent

No check commands, has functions to send results from check_commands to a NSCA server.

RemoteConfiguration

DEPRECATED No check commands, has functions to manage the configuration remotely.

All Commands

A list of all commands (alphabetically).

• CheckAlwaysCRITICAL (check)
• CheckAlwaysOK (check)
• CheckAlwaysWARNING (check)
• CheckCPU (check)
• CheckCRITICAL (check)
• CheckCounter (check)
• CheckEventLog/CheckEventLog (check)
• CheckFile (check)
• CheckFileSize (check)
• CheckMem (check)
• CheckMultiple (check)
• CheckOK (check)
• CheckProcState (check)
• CheckServiceState (check)
• CheckTaskSched/CheckTaskSched (check)
• CheckUpTime (check)
• CheckVersion (check)
• CheckWARNING (check)
• CheckWMI/CheckWMI (check)
• CheckWMIValue (check)