Modules

NSClient++ comes with a set of modules out of the box that perform various checks and functions. 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.

NSCAServer]

NSCA server (w/ encryption): A simple server that listens for incoming NSCA connection and handles them. Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST}

Queries (commands)

No commands avalible in NSCAServer

Commands (executable)

TODO: Add command list

CheckSystem]

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

Queries (commands)

• checkUpTime Check the up-time of the computer.
• checkCPU Check the CPU load of the computer.
• checkMem Check free/used memory on the system.
• listCounterInstances? List all instances for a counter.
• checkProcState Check the state of one or more of the processes running on the computer.
• checkCounter Check a PDH counter.
• checkSingleRegEntry? Check registry key
• checkServiceState Check the state of one or more of the computer services.

Commands (executable)

TODO: Add command list

CheckTaskSched]

CheckTaskSched: CheckTaskSched can check various file and disk related things. The current version has commands to check Size of hard drives and directories.

Queries (commands)

No commands avalible in CheckTaskSched

Commands (executable)

TODO: Add command list

CheckHelpers]

Helper function: Various helper function to extend other checks. This is also only supported through NRPE.

Queries (commands)

• CheckAlwaysWARNING? Run another check and regardless of its return code return WARN.
• CheckVersion? Just return the nagios version (along with OK status).
• check_ok Just return OK (anything passed along will be used as a message).
• CheckWARNING? Just return WARN (anything passed along will be used as a message).
• CheckAlwaysOK? Run another check and regardless of its return code return OK.
• CheckCRITICAL? Just return CRIT (anything passed along will be used as a message).
• CheckOK? Just return OK (anything passed along will be used as a message).
• CheckMultiple? Run more then one check and return the worst state.
• CheckAlwaysCRITICAL? Run another check and regardless of its return code return CRIT.

Commands (executable)

TODO: Add command list

NSCPServer]

NSCP server: A simple server that listens for incoming NSCP connection and handles them.

Queries (commands)

No commands avalible in NSCPServer

Commands (executable)

TODO: Add command list

NSClientServer]

NSClient server: A simple server that listens for incoming NSClient (check_nt) connection and handles them. Although NRPE is the preferred method NSClient is fully supported and can be used for simplicity or for compatibility.

Queries (commands)

No commands avalible in NSClientServer

Commands (executable)

TODO: Add command list

NRPEServer]

NRPE server: A simple server that listens for incoming NRPE connection and handles them.

Queries (commands)

No commands avalible in NRPEServer

Commands (executable)

TODO: Add command list

Scheduler]

Scheduler: A scheduler which schedules checks at regular intervals

Queries (commands)

No commands avalible in Scheduler

Commands (executable)

TODO: Add command list

CheckTaskSched2]

CheckTaskSched2: CheckTaskSched2 can check various file and disk related things. The current version has commands to check Size of hard drives and directories.

Queries (commands)

• CheckTaskSchedValue? Run a WMI query and check the resulting value (the values of each row determin the state).
• CheckTaskSched? Run a WMI query and check the resulting rows (the number of hits determine state).

Commands (executable)

TODO: Add command list

CheckDisk]

CheckDisk: CheckDisk can check various file and disk related things. The current version has commands to check Size of hard drives and directories.

Queries (commands)

• CheckFileSize Check or directory a file and verify its size.
• CheckFiles Check various aspects of a file and/or folder.
• CheckFile2? (deprecated) Check various aspects of a file and/or folder.
• CheckDriveSize? Check the size (free-space) of a drive or volume.

Commands (executable)

TODO: Add command list

NRPEClient]

NRPE client (w/ SSL): A simple client for checking remote NRPE servers (think proxy).

Queries (commands)

• nrpe_help? Help on using NRPE Client
• nrpe_exec Execute (via query) remote NRPE host
• nrpe_submit Submit (via query) remote NRPE host
• nrpe_query Check remote NRPE host
• nrpe_forward? Forward query to remote NRPE host

Commands (executable)

TODO: Add command list

CauseCrashes]

Helper function: Various helper function to extend other checks. This is also only supported through NRPE.

Queries (commands)

• CrashClient? Crash NSClient++

Commands (executable)

TODO: Add command list

PythonScript]

PythonScript: PythonScript...

Queries (commands)

No commands avalible in PythonScript

Commands (executable)

TODO: Add command list

SMTPClient]

SMTPClient: Passive check support via SMTP

Queries (commands)

• smtp_query? Check remote SMTP host
• smtp_help? Help on using SMTP Client
• smtp_exec? Execute (via query) remote SMTP host
• smtp_submit Submit (via query) remote SMTP host
• smtp_forward? Forward query to remote SMTP host

Commands (executable)

TODO: Add command list

SyslogClient]

SyslogClient: Passive check support via Syslog

Queries (commands)

• syslog_help? Help on using NRPE Client
• syslog_submit Submit (via query) remote NRPE host
• syslog_exec? Execute (via query) remote NRPE host
• syslog_query? Check remote NRPE host
• syslog_forward? Forward query to remote NRPE host

Commands (executable)

TODO: Add command list

CheckWMI]

CheckWMI: CheckWMI can check various file and disk related things. The current version has commands to check Size of hard drives and directories.

Queries (commands)

• CheckWMI Run a WMI query and check the resulting rows (the number of hits determine state).
• CheckWMIValue Run a WMI query and check the resulting value (the values of each row determin the state).

Commands (executable)

TODO: Add command list

NSCAClient]

NSCAClient: Passive check support over NSCA. Avalible crypto are: {0=No Encryption (not safe), 1=XOR, 2=DES, 3=DES-EDE3, 4=CAST-128, 6=XTEA, 8=Blowfish, 9=Twofish, 11=RC2, 14=AES, 15=AES, 16=AES, 20=Serpent, 23=GOST}

Queries (commands)

• nsca_forward? Forward query to remote NRPE host
• nsca_submit Submit (via query) remote NRPE host
• nsca_help? Help on using NRPE Client
• nsca_query? Check remote NRPE host
• nsca_exec? Execute (via query) remote NRPE host

Commands (executable)

TODO: Add command list

NSCPClient]

NSCP client (w/ SSL): A simple client for checking remote NSCP servers (think proxy).

Queries (commands)

• nscp_forward? Forward query to remote NSCP host
• nscp_submit? Submit a query to a remote host via NSCP
• nscp_help? Help on using NSCP Client
• nscp_query? Submit a query to a remote host via NSCP
• nscp_exec? Execute remote command on a remote host via NSCP

Commands (executable)

TODO: Add command list

CheckExternalScripts]

Check External Scripts: A simple wrapper to run external scripts and batch files.

Queries (commands)

• alias_sched_all? Alias for: alias_sched_all
• alias_service? Alias for: alias_service
• alias_event_log? Alias for: alias_event_log
• alias_process_stopped? Alias for: alias_process_stopped
• alias_cpu_ex? Alias for: alias_cpu_ex
• alias_sched_task? Alias for: alias_sched_task
• alias_volumes_loose? Alias for: alias_volumes_loose
• alias_volumes? Alias for: alias_volumes
• alias_sched_long? Alias for: alias_sched_long
• alias_updates? Alias for: alias_updates
• alias_mem? Alias for: alias_mem
• alias_disk? Alias for: alias_disk
• alias_file_age? Alias for: alias_file_age
• alias_process_count? Alias for: alias_process_count
• alias_cpu? Alias for: alias_cpu
• alias_process? Alias for: alias_process
• alias_file_size? Alias for: alias_file_size
• alias_process_hung? Alias for: alias_process_hung
• alias_service_ex? Alias for: alias_service_ex
• alias_up? Alias for: alias_up
• alias_disk_loose? Alias for: alias_disk_loose

Commands (executable)

TODO: Add command list

LUAScript]

LUAScript: LUAScript...

Queries (commands)

No commands avalible in LUAScript

Commands (executable)

TODO: Add command list

NRDPClient]

NRDPClient: Passive check support over NRDP

Queries (commands)

• nrdp_submit Submit (via query) remote NRDP host
• nrdp_help? Help on using NRDPClient
• nrdp_forward? Forward query to remote NRDP host
• nrdp_exec? Execute remote NRDP host

Commands (executable)

TODO: Add command list

CheckNSCP]

Check NSCP: Checkes the state of the agent

Queries (commands)

• check_nscp Check the internal healt of NSClient++.

Commands (executable)

TODO: Add command list

CheckEventLog]

Event log Checker.: Check for errors and warnings in the event log. This is only supported through NRPE so if you plan to use only NSClient this wont help you at all.

Queries (commands)

• checkeventlogcache? Check for errors in the event logger!
• check_eventlog_cache? Check for errors in the event logger!
• CheckEventLog Check for errors in the event logger!
• check_eventlog Check for errors in the event logger!

Commands (executable)

TODO: Add command list

GraphiteClient]

NSCAClient (without encryption support): Graphite client

Queries (commands)

• graphite_help? Help
• graphite_forward? Forward query to remote host
• graphite_exec? Execute command on remote host
• graphite_query? QUery remote host
• graphite_submit Submit to remote host

Commands (executable)

TODO: Add command list

All Commands

A list of all commands (alphabetically). ListTagged(check)?