source: nscp/trunk/readme.txt @ ebcb766

Last change on this file since ebcb766 was ebcb766, checked in by Michael Medin <michael@…>, 8 years ago
  • Changed the Thread class a bit (mutex -> signal, and CreatThread? does not return the instance)
  • Moved settings "keys" fro NRPE to config.h
  • Changed build options (added Distribution) which builds a zip file under ./dist (requires 7z installed)
  • Minor tweaks to error/debug logging and small fixes "here and there"
  • Property mode set to 100644
File size: 2.3 KB
Line 
1NSClient++ is a windows service that allows performance metrics to be gathered by Nagios
2(and possibly other monitoring tools). It is an attempt to create a NSClient and NRPE compatible
3but yet extendable performance service for windows.
4
5NSClient
6The following commands (from check_nt) are supported.
7 * CLIENTVERSION
8 * CPULOAD
9 * UPTIME
10 * USEDDISKSPACE
11 * MEMUSE
12 * SERVICESTATE
13 * PROCSTATE
14
15NRPE
16All scripts "should" work (haven't actually tried myself though).
17Notice that encryption is still missing.
18
19Installation:
20To install simply copy all files to directory on the server and run
21the following command: "NSClient++ /install" to un-install run:
22"NSClient++ /uninstall".
23
24The NSClient++ has the following command syntax:
25NSClient++ -<command>
26  <command>
27    install     - Install the service
28    start       - Start the service
29    stop        - Stop the service
30    about       - Show some info (version et.al.)
31    version     - Show some info
32    test        - Run interactively. Useful for debugging purposes.
33
34The directory structure:
35  <install root>
36    - NSClient++.exe    - The executable (and service)
37    - NSC.ini                   - The INI file (settings)
38    - changelog                 - "Whats new"
39    - *.dll                             - Various runtime DLLs
40    - readme.txt                - This file
41    <modules>
42      - Various NSClient++ modules available to this instance.
43
44A quick description of the included modules:
45* CheckDisk.dll
46        Dick check plug-in (not very complete as of yet).
47* CheckEventLog.dll
48        A very basic event log checker (HINT feedback wanted :)
49* FileLogger.dll
50        Log messages to file (Useful when reporting bugs, also please enable debug=1)
51* NRPEListener.dll
52        NRPE client code. Both listener and executer.
53        Might in the future rename this to NRPE or I will split the module into two.
54* NSClientCompat.dll
55        NSCLient compatibility module. Provides NSClient commands.
56        This module will be migrated in to various other modules in the "near" future.
57* NSClientListener.dll
58        The NSClient listener.
59* SysTray.dll
60        Shows a system tray when the service (exe) is started and allows you to view the log file and inject commands.
61
62Settings:
63For details refer to NSC.ini.
64
65About NSClient++
66URL: http://www.sf.net/projects/nscplus
67
68Contact the author:
69Michael Medin
70EMail: michael <at> medin <dot> name
71Address: (feel free to send a postcard if you find this useful :)
72Michael Medin
73Terapivaegen 6b 3tr
74SE-141 55 HUDDINGE
75SWEDEN
Note: See TracBrowser for help on using the repository browser.