source: nscp/readme.html @ 2603350

0.4.00.4.10.4.2stable
Last change on this file since 2603350 was cea178b, checked in by Michael Medin <michael@…>, 8 years ago

MAJOR CHANGES
2004-04-19 MickeM

+ Added SSL support
+ Added alot of new options
+ Added documentation

  • Renamed and restructured NSCLientCompat to CheckSystem
  • *ALOT* of fixes all over : We are now starting to get to something that is "stable" : This means that soon you might actually be able to use this.
  • Property mode set to 100644
File size: 80.4 KB
Line 
1<html>
2
3<head>
4<meta http-equiv=Content-Type content="text/html; charset=windows-1252">
5<meta name=Generator content="Microsoft Word 11 (filtered)">
6<title>NSClient++</title>
7<style>
8<!--
9 /* Font Definitions */
10 @font-face
11        {font-family:"MS Mincho";
12        panose-1:2 2 6 9 4 2 5 8 3 4;}
13@font-face
14        {font-family:"\@MS Mincho";
15        panose-1:2 2 6 9 4 2 5 8 3 4;}
16 /* Style Definitions */
17 p.MsoNormal, li.MsoNormal, div.MsoNormal
18        {margin:0in;
19        margin-bottom:.0001pt;
20        font-size:12.0pt;
21        font-family:"Times New Roman";}
22h1
23        {margin-top:12.0pt;
24        margin-right:0in;
25        margin-bottom:3.0pt;
26        margin-left:0in;
27        page-break-after:avoid;
28        font-size:16.0pt;
29        font-family:Arial;}
30h2
31        {margin-top:12.0pt;
32        margin-right:0in;
33        margin-bottom:3.0pt;
34        margin-left:0in;
35        page-break-after:avoid;
36        font-size:14.0pt;
37        font-family:Arial;
38        font-style:italic;}
39h3
40        {margin-top:12.0pt;
41        margin-right:0in;
42        margin-bottom:3.0pt;
43        margin-left:0in;
44        page-break-after:avoid;
45        font-size:13.0pt;
46        font-family:Arial;}
47p.MsoToc1, li.MsoToc1, div.MsoToc1
48        {margin-top:12.0pt;
49        margin-right:0in;
50        margin-bottom:6.0pt;
51        margin-left:0in;
52        font-size:10.0pt;
53        font-family:"Times New Roman";
54        font-weight:bold;}
55p.MsoToc2, li.MsoToc2, div.MsoToc2
56        {margin-top:6.0pt;
57        margin-right:0in;
58        margin-bottom:0in;
59        margin-left:12.0pt;
60        margin-bottom:.0001pt;
61        font-size:10.0pt;
62        font-family:"Times New Roman";
63        font-style:italic;}
64p.MsoToc3, li.MsoToc3, div.MsoToc3
65        {margin-top:0in;
66        margin-right:0in;
67        margin-bottom:0in;
68        margin-left:24.0pt;
69        margin-bottom:.0001pt;
70        font-size:10.0pt;
71        font-family:"Times New Roman";}
72p.MsoToc4, li.MsoToc4, div.MsoToc4
73        {margin-top:0in;
74        margin-right:0in;
75        margin-bottom:0in;
76        margin-left:.5in;
77        margin-bottom:.0001pt;
78        font-size:10.0pt;
79        font-family:"Times New Roman";}
80p.MsoToc5, li.MsoToc5, div.MsoToc5
81        {margin-top:0in;
82        margin-right:0in;
83        margin-bottom:0in;
84        margin-left:48.0pt;
85        margin-bottom:.0001pt;
86        font-size:10.0pt;
87        font-family:"Times New Roman";}
88p.MsoToc6, li.MsoToc6, div.MsoToc6
89        {margin-top:0in;
90        margin-right:0in;
91        margin-bottom:0in;
92        margin-left:60.0pt;
93        margin-bottom:.0001pt;
94        font-size:10.0pt;
95        font-family:"Times New Roman";}
96p.MsoToc7, li.MsoToc7, div.MsoToc7
97        {margin-top:0in;
98        margin-right:0in;
99        margin-bottom:0in;
100        margin-left:1.0in;
101        margin-bottom:.0001pt;
102        font-size:10.0pt;
103        font-family:"Times New Roman";}
104p.MsoToc8, li.MsoToc8, div.MsoToc8
105        {margin-top:0in;
106        margin-right:0in;
107        margin-bottom:0in;
108        margin-left:84.0pt;
109        margin-bottom:.0001pt;
110        font-size:10.0pt;
111        font-family:"Times New Roman";}
112p.MsoToc9, li.MsoToc9, div.MsoToc9
113        {margin-top:0in;
114        margin-right:0in;
115        margin-bottom:0in;
116        margin-left:96.0pt;
117        margin-bottom:.0001pt;
118        font-size:10.0pt;
119        font-family:"Times New Roman";}
120a:link, span.MsoHyperlink
121        {color:blue;
122        text-decoration:underline;}
123a:visited, span.MsoHyperlinkFollowed
124        {color:purple;
125        text-decoration:underline;}
126@page Section1
127        {size:595.3pt 841.9pt;
128        margin:70.85pt 70.85pt 70.85pt 70.85pt;}
129div.Section1
130        {page:Section1;}
131-->
132</style>
133
134</head>
135
136<body lang=SV link=blue vlink=purple>
137
138<div class=Section1>
139
140<h1><a name="_Toc101631085"><span lang=EN-US>About NSClient++</span></a></h1>
141
142<p class=MsoNormal><span lang=EN-US>NSClient++ (or nscp as I tend to call it
143nowadays) aims to be a simple yet powerful and secure monitoring daemon for
144windows operating systems. It is built for Nagios but nothing in the daemon is
145actually Nagios specific and could probably with little or no change be
146integrated in any monitoring software that supports running user tools for
147polling.</span></p>
148
149<p class=MsoNormal><span lang=EN-US>The structure of the daemon is a simple NT
150service that loads a plug-ins to an internal stack. The plug-ins can then
151request data (poll performance data) from the other plug-ins through the
152internal stack. As of now there are a few plug-ins for basic performance data
153collection. </span></p>
154
155<p class=MsoNormal><span lang=EN-US>NSClient++ can be extended in two ways you
156can either write your own plug-in to or you can execute an external script (as
157of now batch/exe/*). Writing your own plug-in is of course the most powerful
158way but requires knowledge of C++ or other language which can produce DLLs and
159interface with regular C programs.</span></p>
160
161<h1><a name="_Toc101631086"><span lang=EN-US>Table of Contents</span></a></h1>
162
163<p class=MsoToc1><span
164class=MsoHyperlink><a href="#_Toc101631085"><span lang=EN-US>About NSClient++</span><span
165lang=EN-US style='color:windowtext;display:none;text-decoration:none'> </span><span
166style='color:windowtext;display:none;text-decoration:none'>1</span></a></span></p>
167
168<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc101631086"><span
169lang=EN-US>Table of Contents</span><span lang=EN-US style='color:windowtext;
170display:none;text-decoration:none'> </span><span
171style='color:windowtext;display:none;text-decoration:none'>1</span></a></span></p>
172
173<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc101631087"><span
174lang=EN-US>Modules</span><span lang=EN-US style='color:windowtext;display:none;
175text-decoration:none'> </span><span
176style='color:windowtext;display:none;text-decoration:none'>2</span></a></span></p>
177
178<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631088"><span
179lang=EN-US>CheckDisk.dll</span><span lang=EN-US style='color:windowtext;
180display:none;text-decoration:none'> </span><span
181style='color:windowtext;display:none;text-decoration:none'>2</span></a></span></p>
182
183<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631089">CheckFileSize<span
184style='color:windowtext;display:none;text-decoration:none'> </span><span
185style='color:windowtext;display:none;text-decoration:none'>2</span></a></span></p>
186
187<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631090"><span
188lang=EN-US>CheckDriveSize</span><span lang=EN-US style='color:windowtext;
189display:none;text-decoration:none'> </span><span
190style='color:windowtext;display:none;text-decoration:none'>3</span></a></span></p>
191
192<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631091"><span
193lang=EN-US>CheckEventLog.dll</span><span lang=EN-US style='color:windowtext;
194display:none;text-decoration:none'> </span><span
195style='color:windowtext;display:none;text-decoration:none'>3</span></a></span></p>
196
197<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631092">CheckEventLog<span
198style='color:windowtext;display:none;text-decoration:none'> </span><span
199style='color:windowtext;display:none;text-decoration:none'>3</span></a></span></p>
200
201<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631093"><span
202lang=EN-US>CheckSystem.dll</span><span lang=EN-US style='color:windowtext;
203display:none;text-decoration:none'> </span><span
204style='color:windowtext;display:none;text-decoration:none'>4</span></a></span></p>
205
206<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631094">checkCPU<span
207style='color:windowtext;display:none;text-decoration:none'> </span><span
208style='color:windowtext;display:none;text-decoration:none'>4</span></a></span></p>
209
210<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631095"><span
211lang=EN-US>checkUpTime</span><span lang=EN-US style='color:windowtext;
212display:none;text-decoration:none'> </span><span
213style='color:windowtext;display:none;text-decoration:none'>4</span></a></span></p>
214
215<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631096"><span
216lang=EN-US>checkServiceState</span><span lang=EN-US style='color:windowtext;
217display:none;text-decoration:none'> </span><span
218style='color:windowtext;display:none;text-decoration:none'>5</span></a></span></p>
219
220<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631097"><span
221lang=EN-US>checkProcState</span><span lang=EN-US style='color:windowtext;
222display:none;text-decoration:none'> </span><span
223style='color:windowtext;display:none;text-decoration:none'>5</span></a></span></p>
224
225<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631098"><span
226lang=EN-US>checkMem</span><span lang=EN-US style='color:windowtext;display:
227none;text-decoration:none'> </span><span
228style='color:windowtext;display:none;text-decoration:none'>5</span></a></span></p>
229
230<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631099"><span
231lang=EN-US>FileLogger.dll</span><span lang=EN-US style='color:windowtext;
232display:none;text-decoration:none'> </span><span
233style='color:windowtext;display:none;text-decoration:none'>5</span></a></span></p>
234
235<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631100"><span
236lang=EN-US>NRPEListener.dll</span><span lang=EN-US style='color:windowtext;
237display:none;text-decoration:none'> </span><span
238style='color:windowtext;display:none;text-decoration:none'>5</span></a></span></p>
239
240<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631101"><span
241lang=EN-US>External commands</span><span lang=EN-US style='color:windowtext;
242display:none;text-decoration:none'> </span><span
243style='color:windowtext;display:none;text-decoration:none'>6</span></a></span></p>
244
245<p class=MsoToc3><span class=MsoHyperlink><a href="#_Toc101631102"><span
246lang=EN-US>Internal commands</span><span lang=EN-US style='color:windowtext;
247display:none;text-decoration:none'> </span><span
248style='color:windowtext;display:none;text-decoration:none'>6</span></a></span></p>
249
250<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631103"><span
251lang=EN-US>CheckSystem.dll</span><span lang=EN-US style='color:windowtext;
252display:none;text-decoration:none'> </span><span
253style='color:windowtext;display:none;text-decoration:none'>6</span></a></span></p>
254
255<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631104"><span
256lang=EN-US>NSClientListener.dll</span><span lang=EN-US style='color:windowtext;
257display:none;text-decoration:none'> </span><span
258style='color:windowtext;display:none;text-decoration:none'>6</span></a></span></p>
259
260<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631105"><span
261lang=EN-US>SysTray.dll</span><span lang=EN-US style='color:windowtext;
262display:none;text-decoration:none'> </span><span
263style='color:windowtext;display:none;text-decoration:none'>6</span></a></span></p>
264
265<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc101631106"><span
266lang=EN-US>Installation</span><span lang=EN-US style='color:windowtext;
267display:none;text-decoration:none'> </span><span
268style='color:windowtext;display:none;text-decoration:none'>6</span></a></span></p>
269
270<p class=MsoToc1><span class=MsoHyperlink><a href="#_Toc101631107"><span
271lang=EN-US>Configuration</span><span lang=EN-US style='color:windowtext;
272display:none;text-decoration:none'> </span><span
273style='color:windowtext;display:none;text-decoration:none'>7</span></a></span></p>
274
275<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631108"><span
276lang=EN-US>Log</span><span lang=EN-US style='color:windowtext;display:none;
277text-decoration:none'> </span><span
278style='color:windowtext;display:none;text-decoration:none'>7</span></a></span></p>
279
280<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631109"><span
281lang=EN-US>Systray</span><span lang=EN-US style='color:windowtext;display:none;
282text-decoration:none'> </span><span
283style='color:windowtext;display:none;text-decoration:none'>7</span></a></span></p>
284
285<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631110"><span
286lang=EN-US>NSClient</span><span lang=EN-US style='color:windowtext;display:
287none;text-decoration:none'> </span><span
288style='color:windowtext;display:none;text-decoration:none'>7</span></a></span></p>
289
290<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631111"><span
291lang=EN-US>NRPE</span><span lang=EN-US style='color:windowtext;display:none;
292text-decoration:none'> </span><span
293style='color:windowtext;display:none;text-decoration:none'>8</span></a></span></p>
294
295<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631112"><span
296lang=EN-US>NRPE Handlers</span><span lang=EN-US style='color:windowtext;
297display:none;text-decoration:none'> </span><span
298style='color:windowtext;display:none;text-decoration:none'>8</span></a></span></p>
299
300<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631113"><span
301lang=EN-US>Check System</span><span lang=EN-US style='color:windowtext;
302display:none;text-decoration:none'> </span><span
303style='color:windowtext;display:none;text-decoration:none'>8</span></a></span></p>
304
305<p class=MsoToc2><span class=MsoHyperlink><a href="#_Toc101631114"><span
306lang=EN-US>modules</span><span lang=EN-US style='color:windowtext;display:none;
307text-decoration:none'> </span><span
308style='color:windowtext;display:none;text-decoration:none'>9</span></a></span></p>
309
310<p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
311
312<h1><a name="_Toc101631087"><span lang=EN-US>Modules</span></a></h1>
313
314<p class=MsoNormal><span lang=EN-US>NSClient++ comes with a few modules out of
315the box that does various checks. A list of the modules and there potential use
316is listed below here.</span></p>
317
318<h2><a name="_Toc101631088"><span lang=EN-US>CheckDisk.dll</span></a></h2>
319
320<p class=MsoNormal><span lang=EN-US>This module has various disk related checks
321such as drive/directory usage and hopefully in the future more similar such
322checks. Feel free to request checks that you feel are good to have.</span></p>
323
324<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
325 style='border-collapse:collapse;border:none'>
326 <tr>
327  <td width=134 valign=top style='width:100.85pt;border:solid windowtext 1.0pt;
328  padding:0in 5.4pt 0in 5.4pt'>
329  <p class=MsoNormal><span lang=EN-US>Command</span></p>
330  </td>
331  <td width=473 valign=top style='width:354.55pt;border:solid windowtext 1.0pt;
332  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
333  <p class=MsoNormal><span lang=EN-US>Description</span></p>
334  </td>
335 </tr>
336 <tr>
337  <td width=134 valign=top style='width:100.85pt;border:solid windowtext 1.0pt;
338  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
339  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CheckFileSize</span></p>
340  </td>
341  <td width=473 valign=top style='width:354.55pt;border-top:none;border-left:
342  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
343  padding:0in 5.4pt 0in 5.4pt'>
344  <p class=MsoNormal><span lang=EN-US>Check the size of one or more files or
345  directories.</span></p>
346  </td>
347 </tr>
348 <tr>
349  <td width=134 valign=top style='width:100.85pt;border:solid windowtext 1.0pt;
350  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
351  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CheckDriveSize</span></p>
352  </td>
353  <td width=473 valign=top style='width:354.55pt;border-top:none;border-left:
354  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
355  padding:0in 5.4pt 0in 5.4pt'>
356  <p class=MsoNormal><span lang=EN-US>Check the size of one or more Drives</span></p>
357  </td>
358 </tr>
359</table>
360
361<h3><a name="_Toc101631089">CheckFileSize</a></h3>
362
363<p class=MsoNormal><span lang=EN-US>This check does a recursive size
364calculation of the directory (or file) specified. A request has one or more
365options described in the table below. </span></p>
366
367<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
368 style='border-collapse:collapse;border:none'>
369 <tr>
370  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
371  padding:0in 5.4pt 0in 5.4pt'>
372  <p class=MsoNormal><span lang=EN-US>Option</span></p>
373  </td>
374  <td width=205 valign=top style='width:153.55pt;border:solid windowtext 1.0pt;
375  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
376  <p class=MsoNormal><span lang=EN-US>Values</span></p>
377  </td>
378  <td width=205 valign=top style='width:153.55pt;border:solid windowtext 1.0pt;
379  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
380  <p class=MsoNormal><span lang=EN-US>Description</span></p>
381  </td>
382 </tr>
383 <tr>
384  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
385  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
386  <p class=MsoNormal><span lang=EN-US>MaxWarn</span></p>
387  </td>
388  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
389  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
390  padding:0in 5.4pt 0in 5.4pt'>
391  <p class=MsoNormal><span lang=EN-US>Size GMKB</span></p>
392  </td>
393  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
394  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
395  padding:0in 5.4pt 0in 5.4pt'>
396  <p class=MsoNormal><span lang=EN-US>The maximum size the directory is allowed
397  before a warning state is returned.</span></p>
398  </td>
399 </tr>
400 <tr>
401  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
402  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
403  <p class=MsoNormal><span lang=EN-US>MaxCrit</span></p>
404  </td>
405  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
406  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
407  padding:0in 5.4pt 0in 5.4pt'>
408  <p class=MsoNormal><span lang=EN-US>Size GMKB</span></p>
409  </td>
410  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
411  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
412  padding:0in 5.4pt 0in 5.4pt'>
413  <p class=MsoNormal><span lang=EN-US>The maximum size the directory is allowed
414  before a critical state is returned.</span></p>
415  </td>
416 </tr>
417 <tr>
418  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
419  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
420  <p class=MsoNormal><span lang=EN-US>MinWarn</span></p>
421  </td>
422  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
423  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
424  padding:0in 5.4pt 0in 5.4pt'>
425  <p class=MsoNormal><span lang=EN-US>Size GMKB</span></p>
426  </td>
427  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
428  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
429  padding:0in 5.4pt 0in 5.4pt'>
430  <p class=MsoNormal><span lang=EN-US>The minimum size the directory is allowed
431  before a warning state is returned.</span></p>
432  </td>
433 </tr>
434 <tr>
435  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
436  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
437  <p class=MsoNormal><span lang=EN-US>MinCrit</span></p>
438  </td>
439  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
440  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
441  padding:0in 5.4pt 0in 5.4pt'>
442  <p class=MsoNormal><span lang=EN-US>Size GMKB</span></p>
443  </td>
444  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
445  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
446  padding:0in 5.4pt 0in 5.4pt'>
447  <p class=MsoNormal><span lang=EN-US>The minimum size the directory is allowed
448  before a critical state is returned.</span></p>
449  </td>
450 </tr>
451 <tr>
452  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
453  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
454  <p class=MsoNormal><span lang=EN-US>ShowAll</span></p>
455  </td>
456  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
457  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
458  padding:0in 5.4pt 0in 5.4pt'>
459  <p class=MsoNormal><i><span lang=EN-US>None</span></i></p>
460  </td>
461  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
462  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
463  padding:0in 5.4pt 0in 5.4pt'>
464  <p class=MsoNormal><span lang=EN-US>A Boolean flag to show size of
465  directories that are not in an alarm state. If this is not specified only
466  drives with an alarm state will be listed in the resulting string.</span></p>
467  </td>
468 </tr>
469 <tr>
470  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
471  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
472  <p class=MsoNormal><span lang=EN-US>File</span></p>
473  </td>
474  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
475  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
476  padding:0in 5.4pt 0in 5.4pt'>
477  <p class=MsoNormal><span lang=EN-US>File or directory name</span></p>
478  </td>
479  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
480  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
481  padding:0in 5.4pt 0in 5.4pt'>
482  <p class=MsoNormal><span lang=EN-US>The name of the file or directory that
483  should have its size calculated. Notice that large directory structures will
484  take a long time to check.</span></p>
485  </td>
486 </tr>
487 <tr>
488  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
489  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
490  <p class=MsoNormal><span lang=EN-US>File:&lt;alias&gt;</span></p>
491  </td>
492  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
493  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
494  padding:0in 5.4pt 0in 5.4pt'>
495  <p class=MsoNormal><span lang=EN-US>File or directory name</span></p>
496  </td>
497  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
498  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
499  padding:0in 5.4pt 0in 5.4pt'>
500  <p class=MsoNormal><span lang=EN-US>Same as the file option but using a short
501  alias in the returned data.</span></p>
502  </td>
503 </tr>
504</table>
505
506<p class=MsoNormal><span lang=EN-US>The “Size gmkb” is a way to simply specify
507large sizes simply add a postfix describing the unit you want thus 1k is the
508same as 1024. 1m is the same as 1048576 etc.</span></p>
509
510<p class=MsoNormal><span lang=EN-US>Example: </span></p>
511
512<p class=MsoNormal><i><span lang=EN-US>CheckFileSize ShowAll MaxWarn=1024M
513MaxCrit=4096M File:WIN=c:\WINDOWS\*.*</span></i></p>
514
515<p class=MsoNormal><span lang=EN-US>Will return something along the lines of
516this:</span></p>
517
518<p class=MsoNormal><i><span lang=EN-US>WIN: 1G
519(2110962363B)|WIN:2110962363:1073741824:4294967296</span></i></p>
520
521<h3><a name="_Toc101631090"><span lang=EN-US>CheckDriveSize</span></a></h3>
522
523<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
524 style='border-collapse:collapse;border:none'>
525 <tr>
526  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
527  padding:0in 5.4pt 0in 5.4pt'>
528  <p class=MsoNormal><span lang=EN-US>Option</span></p>
529  </td>
530  <td width=205 valign=top style='width:153.55pt;border:solid windowtext 1.0pt;
531  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
532  <p class=MsoNormal><span lang=EN-US>Values</span></p>
533  </td>
534  <td width=205 valign=top style='width:153.55pt;border:solid windowtext 1.0pt;
535  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
536  <p class=MsoNormal><span lang=EN-US>Description</span></p>
537  </td>
538 </tr>
539 <tr>
540  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
541  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
542  <p class=MsoNormal><span lang=EN-US>MaxWarn</span></p>
543  </td>
544  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
545  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
546  padding:0in 5.4pt 0in 5.4pt'>
547  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
548  </td>
549  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
550  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
551  padding:0in 5.4pt 0in 5.4pt'>
552  <p class=MsoNormal><span lang=EN-US>The maximum size the directory is allowed
553  before a warning state is returned.</span></p>
554  </td>
555 </tr>
556 <tr>
557  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
558  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
559  <p class=MsoNormal><span lang=EN-US>MaxCrit</span></p>
560  </td>
561  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
562  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
563  padding:0in 5.4pt 0in 5.4pt'>
564  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
565  </td>
566  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
567  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
568  padding:0in 5.4pt 0in 5.4pt'>
569  <p class=MsoNormal><span lang=EN-US>The maximum size the directory is allowed
570  before a critical state is returned.</span></p>
571  </td>
572 </tr>
573 <tr>
574  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
575  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
576  <p class=MsoNormal><span lang=EN-US>MinWarn</span></p>
577  </td>
578  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
579  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
580  padding:0in 5.4pt 0in 5.4pt'>
581  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
582  </td>
583  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
584  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
585  padding:0in 5.4pt 0in 5.4pt'>
586  <p class=MsoNormal><span lang=EN-US>The minimum size the directory is allowed
587  before a warning state is returned.</span></p>
588  </td>
589 </tr>
590 <tr>
591  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
592  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
593  <p class=MsoNormal><span lang=EN-US>MinCrit</span></p>
594  </td>
595  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
596  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
597  padding:0in 5.4pt 0in 5.4pt'>
598  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
599  </td>
600  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
601  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
602  padding:0in 5.4pt 0in 5.4pt'>
603  <p class=MsoNormal><span lang=EN-US>The minimum size the directory is allowed
604  before a critical state is returned.</span></p>
605  </td>
606 </tr>
607 <tr>
608  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
609  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
610  <p class=MsoNormal><span lang=EN-US>ShowAll</span></p>
611  </td>
612  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
613  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
614  padding:0in 5.4pt 0in 5.4pt'>
615  <p class=MsoNormal><i><span lang=EN-US>None</span></i></p>
616  </td>
617  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
618  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
619  padding:0in 5.4pt 0in 5.4pt'>
620  <p class=MsoNormal><span lang=EN-US>A Boolean flag to show size of
621  directories that are not in an alarm state. If this is not specified only
622  drives with an alarm state will be listed in the resulting string.</span></p>
623  </td>
624 </tr>
625 <tr>
626  <td width=205 valign=top style='width:153.5pt;border:solid windowtext 1.0pt;
627  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
628  <p class=MsoNormal><span lang=EN-US>Drive</span></p>
629  </td>
630  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
631  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
632  padding:0in 5.4pt 0in 5.4pt'>
633  <p class=MsoNormal><span lang=EN-US>A Drive letter</span></p>
634  </td>
635  <td width=205 valign=top style='width:153.55pt;border-top:none;border-left:
636  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
637  padding:0in 5.4pt 0in 5.4pt'>
638  <p class=MsoNormal><span lang=EN-US>The letter of the drive to check. Notice
639  that the drive has to be a fixed drive.</span></p>
640  </td>
641 </tr>
642</table>
643
644<p class=MsoNormal><span lang=EN-US>The “Size GMKB%” is similar “Size GMKB” but
645with an added option of specifying the value in percent of disk space. For
646example 80% will mean a value of 80% of total drive space.</span></p>
647
648<h2><a name="_Toc101631091"><span lang=EN-US>CheckEventLog.dll</span></a></h2>
649
650<p class=MsoNormal><span lang=EN-US>Simple module to check for errors in the
651system event log. This module is in an early stage and feedback would be
652appreciated.</span></p>
653
654<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
655 style='border-collapse:collapse;border:none'>
656 <tr>
657  <td width=134 valign=top style='width:100.85pt;border:solid windowtext 1.0pt;
658  padding:0in 5.4pt 0in 5.4pt'>
659  <p class=MsoNormal><span lang=EN-US>Command</span></p>
660  </td>
661  <td width=473 valign=top style='width:354.55pt;border:solid windowtext 1.0pt;
662  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
663  <p class=MsoNormal><span lang=EN-US>Description</span></p>
664  </td>
665 </tr>
666 <tr>
667  <td width=134 valign=top style='width:100.85pt;border:solid windowtext 1.0pt;
668  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
669  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CheckEventLog</span></p>
670  </td>
671  <td width=473 valign=top style='width:354.55pt;border-top:none;border-left:
672  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
673  padding:0in 5.4pt 0in 5.4pt'>
674  <p class=MsoNormal><span lang=EN-US>Check for errors in the event log.</span></p>
675  </td>
676 </tr>
677</table>
678
679<h3><a name="_Toc101631092">CheckEventLog</a></h3>
680
681<p class=MsoNormal><span lang=EN-US>Yet to be written</span></p>
682
683<p class=MsoNormal><span lang=EN-US>A quick introduction though:</span></p>
684
685<p class=MsoNormal><span lang=EN-US>First option is the logfile to parse.
686(Application, System etc)</span></p>
687
688<p class=MsoNormal><span lang=EN-US>Options have the following format.</span></p>
689
690<p class=MsoNormal><span lang=EN-US>warn.require.eventType=warning</span></p>
691
692<p class=MsoNormal><span lang=EN-US>&lt;alert&gt;.&lt;action&gt;.&lt;key&gt;=&lt;value&gt;</span></p>
693
694<p class=MsoNormal><span lang=EN-US>Where “alert” is either warning or critical
695or all depending on the type of alert to generate if this rule is matched.</span></p>
696
697<p class=MsoNormal><span lang=EN-US>Where action is either require or exclude
698depending on if the options should be required by the state (if this rule is
699needed to generate an alert) or excluded (if the rule is matched the alert
700cannot be generated).</span></p>
701
702<p class=MsoNormal><span lang=EN-US>Where key is one of the following value:</span></p>
703
704<p class=MsoNormal>eventType</p>
705
706<p class=MsoNormal>eventSource</p>
707
708<p class=MsoNormal>eventSourceRegexp</p>
709
710<p class=MsoNormal>generatedBeforeDelta</p>
711
712<p class=MsoNormal>generatedAfterDelta</p>
713
714<p class=MsoNormal>writtenBeforeDelta</p>
715
716<p class=MsoNormal><span lang=EN-US>writtenAfterDelta</span></p>
717
718<p class=MsoNormal><span lang=EN-US>regexp</span></p>
719
720<p class=MsoNormal><span lang=EN-US>A sample is shown below:</span></p>
721
722<p class=MsoNormal><span lang=EN-US>Application critical.require.eventType=error
723truncate=1024 descriptions all.exclude.eventSourceRegexp=^(Win|Msi|NSClient\+\+|Userenv|ASP\.NET|LoadPerf|Outlook|Application
724E|NSClient).*</span></p>
725
726<h2><a name="_Toc101631093"><span lang=EN-US>CheckSystem.dll</span></a></h2>
727
728<p class=MsoNormal><span lang=EN-US>A module to check various system related
729things. A list of the modules and there potential use is listed below here.</span></p>
730
731<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
732 style='border-collapse:collapse;border:none'>
733 <tr>
734  <td width=150 valign=top style='width:112.85pt;border:solid windowtext 1.0pt;
735  padding:0in 5.4pt 0in 5.4pt'>
736  <p class=MsoNormal><span lang=EN-US>Command</span></p>
737  </td>
738  <td width=469 valign=top style='width:351.55pt;border:solid windowtext 1.0pt;
739  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
740  <p class=MsoNormal><span lang=EN-US>Description</span></p>
741  </td>
742 </tr>
743 <tr>
744  <td width=150 valign=top style='width:112.85pt;border:solid windowtext 1.0pt;
745  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
746  <p class=MsoNormal>checkCPU</p>
747  </td>
748  <td width=469 valign=top style='width:351.55pt;border-top:none;border-left:
749  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
750  padding:0in 5.4pt 0in 5.4pt'>
751  <p class=MsoNormal>Check CPU load</p>
752  </td>
753 </tr>
754 <tr>
755  <td width=150 valign=top style='width:112.85pt;border:solid windowtext 1.0pt;
756  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
757  <p class=MsoNormal>checkUpTime</p>
758  </td>
759  <td width=469 valign=top style='width:351.55pt;border-top:none;border-left:
760  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
761  padding:0in 5.4pt 0in 5.4pt'>
762  <p class=MsoNormal>Check system uptime</p>
763  </td>
764 </tr>
765 <tr>
766  <td width=150 valign=top style='width:112.85pt;border:solid windowtext 1.0pt;
767  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
768  <p class=MsoNormal>checkServiceState</p>
769  </td>
770  <td width=469 valign=top style='width:351.55pt;border-top:none;border-left:
771  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
772  padding:0in 5.4pt 0in 5.4pt'>
773  <p class=MsoNormal>Check state of a service</p>
774  </td>
775 </tr>
776 <tr>
777  <td width=150 valign=top style='width:112.85pt;border:solid windowtext 1.0pt;
778  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
779  <p class=MsoNormal>checkProcState</p>
780  </td>
781  <td width=469 valign=top style='width:351.55pt;border-top:none;border-left:
782  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
783  padding:0in 5.4pt 0in 5.4pt'>
784  <p class=MsoNormal>Check state of a process</p>
785  </td>
786 </tr>
787 <tr>
788  <td width=150 valign=top style='width:112.85pt;border:solid windowtext 1.0pt;
789  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
790  <p class=MsoNormal>checkMem</p>
791  </td>
792  <td width=469 valign=top style='width:351.55pt;border-top:none;border-left:
793  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
794  padding:0in 5.4pt 0in 5.4pt'>
795  <p class=MsoNormal>Check memory usage (page)</p>
796  </td>
797 </tr>
798</table>
799
800<h3><a name="_Toc101631094">checkCPU</a></h3>
801
802<p class=MsoNormal><span lang=EN-US>This check calculates an average of CPU
803usage for a specified period of time. The data is always collected in the
804background and the size and interval is configured from the </span><span
805lang=EN-US style='font-size:10.0pt;font-family:"Courier New"'>CPUBufferSize and
806CheckResolution options. </span><span lang=EN-US>A request has one or more
807options described in the table below. </span></p>
808
809<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
810 style='border-collapse:collapse;border:none'>
811 <tr>
812  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
813  padding:0in 5.4pt 0in 5.4pt'>
814  <p class=MsoNormal><span lang=EN-US>Option</span></p>
815  </td>
816  <td width=84 valign=top style='width:62.8pt;border:solid windowtext 1.0pt;
817  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
818  <p class=MsoNormal><span lang=EN-US>Values</span></p>
819  </td>
820  <td width=463 valign=top style='width:347.45pt;border:solid windowtext 1.0pt;
821  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
822  <p class=MsoNormal><span lang=EN-US>Description</span></p>
823  </td>
824 </tr>
825 <tr>
826  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
827  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
828  <p class=MsoNormal><span lang=EN-US>warn</span></p>
829  </td>
830  <td width=84 valign=top style='width:62.8pt;border-top:none;border-left:none;
831  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
832  padding:0in 5.4pt 0in 5.4pt'>
833  <p class=MsoNormal><span lang=EN-US>load in %</span></p>
834  </td>
835  <td width=463 valign=top style='width:347.45pt;border-top:none;border-left:
836  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
837  padding:0in 5.4pt 0in 5.4pt'>
838  <p class=MsoNormal><span lang=EN-US>Load to go above to generate a warning.</span></p>
839  </td>
840 </tr>
841 <tr>
842  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
843  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
844  <p class=MsoNormal><span lang=EN-US>crit</span></p>
845  </td>
846  <td width=84 valign=top style='width:62.8pt;border-top:none;border-left:none;
847  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
848  padding:0in 5.4pt 0in 5.4pt'>
849  <p class=MsoNormal><span lang=EN-US>load in %</span></p>
850  </td>
851  <td width=463 valign=top style='width:347.45pt;border-top:none;border-left:
852  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
853  padding:0in 5.4pt 0in 5.4pt'>
854  <p class=MsoNormal><span lang=EN-US>Load to go above to generate a critical
855  state.</span></p>
856  </td>
857 </tr>
858 <tr>
859  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
860  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
861  <p class=MsoNormal><span lang=EN-US>time</span></p>
862  </td>
863  <td width=84 valign=top style='width:62.8pt;border-top:none;border-left:none;
864  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
865  padding:0in 5.4pt 0in 5.4pt'>
866  <p class=MsoNormal><span lang=EN-US>time</span></p>
867  </td>
868  <td width=463 valign=top style='width:347.45pt;border-top:none;border-left:
869  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
870  padding:0in 5.4pt 0in 5.4pt'>
871  <p class=MsoNormal><span lang=EN-US>The time to calculate average over.</span></p>
872  </td>
873 </tr>
874 <tr>
875  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
876  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
877  <p class=MsoNormal><span lang=EN-US>nsclient</span></p>
878  </td>
879  <td width=84 valign=top style='width:62.8pt;border-top:none;border-left:none;
880  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
881  padding:0in 5.4pt 0in 5.4pt'>
882  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
883  </td>
884  <td width=463 valign=top style='width:347.45pt;border-top:none;border-left:
885  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
886  padding:0in 5.4pt 0in 5.4pt'>
887  <p class=MsoNormal><span lang=EN-US>Flag to make the plug in run in nsclient
888  compatibility mode</span></p>
889  </td>
890 </tr>
891</table>
892
893<p class=MsoNormal><span lang=EN-US>Time can use any of the following
894postfixes. w=week, d=day, h=hour, m=minute and s=second.</span></p>
895
896<p class=MsoNormal><span lang=EN-US>Example: </span></p>
897
898<p class=MsoNormal><i><span lang=EN-US>checkCPU warn=80 crit=90 time=20m
899time=10s time=4</span></i></p>
900
901<p class=MsoNormal><span lang=EN-US>This will check CPU load 20minutes and
90210seconds and 4 “units” (depends on the current CheckInterval) if any of the
903loads are above 80% a warning state will be returned and if any of the loads
904are above 90% a critical state will be returned.</span></p>
905
906<h3><a name="_Toc101631095"><span lang=EN-US>checkUpTime</span></a></h3>
907
908<p class=MsoNormal><span lang=EN-US>This check checks the uptime of a server
909and if the time is less then the times given as arguments a state is returned.</span></p>
910
911<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
912 style='border-collapse:collapse;border:none'>
913 <tr>
914  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
915  padding:0in 5.4pt 0in 5.4pt'>
916  <p class=MsoNormal><span lang=EN-US>Option</span></p>
917  </td>
918  <td width=84 valign=top style='width:62.8pt;border:solid windowtext 1.0pt;
919  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
920  <p class=MsoNormal><span lang=EN-US>Values</span></p>
921  </td>
922  <td width=463 valign=top style='width:347.45pt;border:solid windowtext 1.0pt;
923  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
924  <p class=MsoNormal><span lang=EN-US>Description</span></p>
925  </td>
926 </tr>
927 <tr>
928  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
929  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
930  <p class=MsoNormal><span lang=EN-US>warn</span></p>
931  </td>
932  <td width=84 valign=top style='width:62.8pt;border-top:none;border-left:none;
933  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
934  padding:0in 5.4pt 0in 5.4pt'>
935  <p class=MsoNormal><span lang=EN-US>time</span></p>
936  </td>
937  <td width=463 valign=top style='width:347.45pt;border-top:none;border-left:
938  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
939  padding:0in 5.4pt 0in 5.4pt'>
940  <p class=MsoNormal><span lang=EN-US>Minimum uptime time to not generate a
941  warning state.</span></p>
942  </td>
943 </tr>
944 <tr>
945  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
946  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
947  <p class=MsoNormal><span lang=EN-US>crit</span></p>
948  </td>
949  <td width=84 valign=top style='width:62.8pt;border-top:none;border-left:none;
950  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
951  padding:0in 5.4pt 0in 5.4pt'>
952  <p class=MsoNormal><span lang=EN-US>time</span></p>
953  </td>
954  <td width=463 valign=top style='width:347.45pt;border-top:none;border-left:
955  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
956  padding:0in 5.4pt 0in 5.4pt'>
957  <p class=MsoNormal><span lang=EN-US>Minimum uptime time to not generate a
958  critical state.</span></p>
959  </td>
960 </tr>
961 <tr>
962  <td width=72 valign=top style='width:54.15pt;border:solid windowtext 1.0pt;
963  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
964  <p class=MsoNormal><span lang=EN-US>nsclient</span></p>
965  </td>
966  <td width=84 valign=top style='width:62.8pt;border-top:none;border-left:none;
967  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
968  padding:0in 5.4pt 0in 5.4pt'>
969  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
970  </td>
971  <td width=463 valign=top style='width:347.45pt;border-top:none;border-left:
972  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
973  padding:0in 5.4pt 0in 5.4pt'>
974  <p class=MsoNormal><span lang=EN-US>Flag to make the plug in run in nsclient
975  compatibility mode</span></p>
976  </td>
977 </tr>
978</table>
979
980<p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
981
982<h3><a name="_Toc101631096"><span lang=EN-US>checkServiceState</span></a></h3>
983
984<p class=MsoNormal><span lang=EN-US>This check checks the state of one or more
985service on the system and generates a critical state if any service is not in
986the required state.</span></p>
987
988<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
989 style='border-collapse:collapse;border:none'>
990 <tr>
991  <td width=98 valign=top style='width:73.55pt;border:solid windowtext 1.0pt;
992  padding:0in 5.4pt 0in 5.4pt'>
993  <p class=MsoNormal><span lang=EN-US>Option</span></p>
994  </td>
995  <td width=83 valign=top style='width:62.1pt;border:solid windowtext 1.0pt;
996  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
997  <p class=MsoNormal><span lang=EN-US>Values</span></p>
998  </td>
999  <td width=438 valign=top style='width:328.75pt;border:solid windowtext 1.0pt;
1000  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1001  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1002  </td>
1003 </tr>
1004 <tr>
1005  <td width=98 valign=top style='width:73.55pt;border:solid windowtext 1.0pt;
1006  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1007  <p class=MsoNormal><span lang=EN-US>ShowAll</span></p>
1008  </td>
1009  <td width=83 valign=top style='width:62.1pt;border-top:none;border-left:none;
1010  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1011  padding:0in 5.4pt 0in 5.4pt'>
1012  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1013  </td>
1014  <td width=438 valign=top style='width:328.75pt;border-top:none;border-left:
1015  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1016  padding:0in 5.4pt 0in 5.4pt'>
1017  <p class=MsoNormal><span lang=EN-US>A flag to toggle if all service states
1018  should be listed.</span></p>
1019  </td>
1020 </tr>
1021 <tr>
1022  <td width=98 valign=top style='width:73.55pt;border:solid windowtext 1.0pt;
1023  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1024  <p class=MsoNormal><span lang=EN-US>ShowFail</span></p>
1025  </td>
1026  <td width=83 valign=top style='width:62.1pt;border-top:none;border-left:none;
1027  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1028  padding:0in 5.4pt 0in 5.4pt'>
1029  <p class=MsoNormal><span lang=EN-US>(default)</span></p>
1030  </td>
1031  <td width=438 valign=top style='width:328.75pt;border-top:none;border-left:
1032  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1033  padding:0in 5.4pt 0in 5.4pt'>
1034  <p class=MsoNormal><span lang=EN-US>A flag to indicate if only failed service
1035  states should be listed.</span></p>
1036  </td>
1037 </tr>
1038 <tr>
1039  <td width=98 valign=top style='width:73.55pt;border:solid windowtext 1.0pt;
1040  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1041  <p class=MsoNormal><span lang=EN-US>service=state</span></p>
1042  </td>
1043  <td width=83 valign=top style='width:62.1pt;border-top:none;border-left:none;
1044  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1045  padding:0in 5.4pt 0in 5.4pt'>
1046  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1047  </td>
1048  <td width=438 valign=top style='width:328.75pt;border-top:none;border-left:
1049  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1050  padding:0in 5.4pt 0in 5.4pt'>
1051  <p class=MsoNormal><span lang=EN-US>A service name and a state the service
1052  should have. The state can be either started or stopped. If no state is given
1053  started is assumed.</span></p>
1054  </td>
1055 </tr>
1056</table>
1057
1058<p class=MsoNormal><span lang=EN-US>Example</span></p>
1059
1060<p class=MsoNormal><i><span lang=EN-US>checkServiceState showAll myService MyStoppedService=stopped</span></i></p>
1061
1062<h3><a name="_Toc101631097"><span lang=EN-US>checkProcState</span></a></h3>
1063
1064<p class=MsoNormal><span lang=EN-US>This check checks the state of one or more processes
1065on the system and generates a critical state if any process is not in the
1066required state </span></p>
1067
1068<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
1069 style='border-collapse:collapse;border:none'>
1070 <tr>
1071  <td width=101 valign=top style='width:75.55pt;border:solid windowtext 1.0pt;
1072  padding:0in 5.4pt 0in 5.4pt'>
1073  <p class=MsoNormal><span lang=EN-US>Option</span></p>
1074  </td>
1075  <td width=83 valign=top style='width:62.0pt;border:solid windowtext 1.0pt;
1076  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1077  <p class=MsoNormal><span lang=EN-US>Values</span></p>
1078  </td>
1079  <td width=436 valign=top style='width:326.85pt;border:solid windowtext 1.0pt;
1080  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1081  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1082  </td>
1083 </tr>
1084 <tr>
1085  <td width=101 valign=top style='width:75.55pt;border:solid windowtext 1.0pt;
1086  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1087  <p class=MsoNormal><span lang=EN-US>ShowAll</span></p>
1088  </td>
1089  <td width=83 valign=top style='width:62.0pt;border-top:none;border-left:none;
1090  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1091  padding:0in 5.4pt 0in 5.4pt'>
1092  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1093  </td>
1094  <td width=436 valign=top style='width:326.85pt;border-top:none;border-left:
1095  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1096  padding:0in 5.4pt 0in 5.4pt'>
1097  <p class=MsoNormal><span lang=EN-US>A flag to toggle if all process states
1098  should be listed.</span></p>
1099  </td>
1100 </tr>
1101 <tr>
1102  <td width=101 valign=top style='width:75.55pt;border:solid windowtext 1.0pt;
1103  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1104  <p class=MsoNormal><span lang=EN-US>ShowFail</span></p>
1105  </td>
1106  <td width=83 valign=top style='width:62.0pt;border-top:none;border-left:none;
1107  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1108  padding:0in 5.4pt 0in 5.4pt'>
1109  <p class=MsoNormal><span lang=EN-US>(default)</span></p>
1110  </td>
1111  <td width=436 valign=top style='width:326.85pt;border-top:none;border-left:
1112  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1113  padding:0in 5.4pt 0in 5.4pt'>
1114  <p class=MsoNormal><span lang=EN-US>A flag to indicate if only failed process
1115  states should be listed.</span></p>
1116  </td>
1117 </tr>
1118 <tr>
1119  <td width=101 valign=top style='width:75.55pt;border:solid windowtext 1.0pt;
1120  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1121  <p class=MsoNormal><span lang=EN-US>process=state</span></p>
1122  </td>
1123  <td width=83 valign=top style='width:62.0pt;border-top:none;border-left:none;
1124  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1125  padding:0in 5.4pt 0in 5.4pt'>
1126  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1127  </td>
1128  <td width=436 valign=top style='width:326.85pt;border-top:none;border-left:
1129  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1130  padding:0in 5.4pt 0in 5.4pt'>
1131  <p class=MsoNormal><span lang=EN-US>A process name and a state the process should
1132  have. The state can be either started or stopped. If no state is given
1133  started is assumed. The name is the name of the executable.</span></p>
1134  </td>
1135 </tr>
1136</table>
1137
1138<p class=MsoNormal><span lang=EN-US>Example</span></p>
1139
1140<p class=MsoNormal><i><span lang=EN-US>checkProcState showAll my.exe quake.exe=stopped
1141word.exe=started</span></i></p>
1142
1143<h3><a name="_Toc101631098"><span lang=EN-US>checkMem</span></a></h3>
1144
1145<p class=MsoNormal><span lang=EN-US>This check checks the memory (page) usage
1146and generates a state if the memory is above or below give parameters.</span></p>
1147
1148<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
1149 style='border-collapse:collapse;border:none'>
1150 <tr>
1151  <td width=79 valign=top style='width:59.45pt;border:solid windowtext 1.0pt;
1152  padding:0in 5.4pt 0in 5.4pt'>
1153  <p class=MsoNormal><span lang=EN-US>Option</span></p>
1154  </td>
1155  <td width=84 valign=top style='width:62.7pt;border:solid windowtext 1.0pt;
1156  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1157  <p class=MsoNormal><span lang=EN-US>Values</span></p>
1158  </td>
1159  <td width=456 valign=top style='width:342.25pt;border:solid windowtext 1.0pt;
1160  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1161  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1162  </td>
1163 </tr>
1164 <tr>
1165  <td width=79 valign=top style='width:59.45pt;border:solid windowtext 1.0pt;
1166  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1167  <p class=MsoNormal><span lang=EN-US>MaxWarn</span></p>
1168  </td>
1169  <td width=84 valign=top style='width:62.7pt;border-top:none;border-left:none;
1170  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1171  padding:0in 5.4pt 0in 5.4pt'>
1172  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
1173  </td>
1174  <td width=456 valign=top style='width:342.25pt;border-top:none;border-left:
1175  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1176  padding:0in 5.4pt 0in 5.4pt'>
1177  <p class=MsoNormal><span lang=EN-US>The maximum size allowed before a warning
1178  state is returned.</span></p>
1179  </td>
1180 </tr>
1181 <tr>
1182  <td width=79 valign=top style='width:59.45pt;border:solid windowtext 1.0pt;
1183  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1184  <p class=MsoNormal><span lang=EN-US>MaxCrit</span></p>
1185  </td>
1186  <td width=84 valign=top style='width:62.7pt;border-top:none;border-left:none;
1187  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1188  padding:0in 5.4pt 0in 5.4pt'>
1189  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
1190  </td>
1191  <td width=456 valign=top style='width:342.25pt;border-top:none;border-left:
1192  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1193  padding:0in 5.4pt 0in 5.4pt'>
1194  <p class=MsoNormal><span lang=EN-US>The maximum size allowed before a
1195  critical state is returned.</span></p>
1196  </td>
1197 </tr>
1198 <tr>
1199  <td width=79 valign=top style='width:59.45pt;border:solid windowtext 1.0pt;
1200  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1201  <p class=MsoNormal><span lang=EN-US>MinWarn</span></p>
1202  </td>
1203  <td width=84 valign=top style='width:62.7pt;border-top:none;border-left:none;
1204  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1205  padding:0in 5.4pt 0in 5.4pt'>
1206  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
1207  </td>
1208  <td width=456 valign=top style='width:342.25pt;border-top:none;border-left:
1209  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1210  padding:0in 5.4pt 0in 5.4pt'>
1211  <p class=MsoNormal><span lang=EN-US>The minimum size allowed before a warning
1212  state is returned.</span></p>
1213  </td>
1214 </tr>
1215 <tr>
1216  <td width=79 valign=top style='width:59.45pt;border:solid windowtext 1.0pt;
1217  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1218  <p class=MsoNormal><span lang=EN-US>MinCrit</span></p>
1219  </td>
1220  <td width=84 valign=top style='width:62.7pt;border-top:none;border-left:none;
1221  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1222  padding:0in 5.4pt 0in 5.4pt'>
1223  <p class=MsoNormal><span lang=EN-US>Size GMKB%</span></p>
1224  </td>
1225  <td width=456 valign=top style='width:342.25pt;border-top:none;border-left:
1226  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1227  padding:0in 5.4pt 0in 5.4pt'>
1228  <p class=MsoNormal><span lang=EN-US>The minimum size allowed before a
1229  critical state is returned.</span></p>
1230  </td>
1231 </tr>
1232 <tr>
1233  <td width=79 valign=top style='width:59.45pt;border:solid windowtext 1.0pt;
1234  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1235  <p class=MsoNormal><span lang=EN-US>ShowAll</span></p>
1236  </td>
1237  <td width=84 valign=top style='width:62.7pt;border-top:none;border-left:none;
1238  border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1239  padding:0in 5.4pt 0in 5.4pt'>
1240  <p class=MsoNormal><i><span lang=EN-US>None</span></i></p>
1241  </td>
1242  <td width=456 valign=top style='width:342.25pt;border-top:none;border-left:
1243  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1244  padding:0in 5.4pt 0in 5.4pt'>
1245  <p class=MsoNormal><span lang=EN-US>A Boolean flag to show size even if no
1246  state is returned (?).</span></p>
1247  </td>
1248 </tr>
1249</table>
1250
1251<h2><a name="_Toc101631099"><span lang=EN-US>FileLogger.dll</span></a></h2>
1252
1253<p class=MsoNormal><span lang=EN-US>A module that logs all messages to file if
1254no logging module is loaded no error messages will be logged thus it is hard to
1255find problems. I recommend using this module at least until NSClient++ becomes
1256stable. Again not a command handler module so no commands.</span></p>
1257
1258<h2><a name="_Toc101631100"><span lang=EN-US>NRPEListener.dll</span></a></h2>
1259
1260<p class=MsoNormal><span lang=EN-US>This module accepts incoming NRPE
1261connections and responds by executing various checks and returns their result. To
1262use this you need to have check_nrpe or another NRPE client. This is similar to
1263check_nt (NSClient) but much more flexible and supports encryption. This only
1264drawback is that it lacks any authorization (something I hope will come within
1265the next few months).</span></p>
1266
1267<p class=MsoNormal><span lang=EN-US>As this module has the ability to generate
1268command handlers by configuration there are command handlers but nothing built
1269in.</span></p>
1270
1271<p class=MsoNormal><span lang=EN-US>This module can add two types of command
1272handlers.</span></p>
1273
1274<p class=MsoNormal><span lang=EN-US>First there are external command handlers
1275that execute a separate program or script and simply return the output and
1276return status from that. The other possibility is to create an alias for an
1277internal command. </span></p>
1278
1279<h3><a name="_Toc101631101"><span lang=EN-US>External commands</span></a></h3>
1280
1281<p class=MsoNormal><span lang=EN-US>To add an external command you add a
1282command definition under the “NRPE Handlers” section. A command definition has
1283the following syntax:</span></p>
1284
1285<p class=MsoNormal><i><span lang=EN-US>command_name=/some/executable with some
1286arguments</span></i></p>
1287
1288<p class=MsoNormal><span lang=EN-US>for instance:</span></p>
1289
1290<p class=MsoNormal><i><span lang=EN-US>test_batch_file=c:\test.bat foo $ARG1$
1291bar</span></i></p>
1292
1293<p class=MsoNormal><span lang=EN-US>The above example will on an incoming
1294“test_batch_file” execute the c:\test.bat file and return the output as text
1295and the return code as the Nagios status.</span></p>
1296
1297<h3><a name="_Toc101631102"><span lang=EN-US>Internal commands</span></a></h3>
1298
1299<p class=MsoNormal><span lang=EN-US>To add an internal command or alias is
1300perhaps a better word. You add a command definition under the “NRPE Handlers”
1301section. A command definition with the following syntax:</span></p>
1302
1303<p class=MsoNormal><i><span lang=EN-US>command_name=inject some_other_command
1304with some arguments</span></i></p>
1305
1306<p class=MsoNormal><span lang=EN-US>for instance:</span></p>
1307
1308<p class=MsoNormal><i><span lang=EN-US>check_cpu=inject checkCPU warn=80
1309crit=90 5 10 15</span></i></p>
1310
1311<p class=MsoNormal><span lang=EN-US>The above example will on an incoming
1312“check_cpu” execute the internal command “checkCPU” with predefined arguments
1313give in the command definition.</span></p>
1314
1315<h2><a name="_Toc101631103"><span lang=EN-US>CheckSystem.dll</span></a></h2>
1316
1317<p class=MsoNormal><span lang=EN-US>A module to do simple system related
1318checks. Such as CPU load memory usage and process and service status.</span></p>
1319
1320<p class=MsoNormal><span lang=EN-US>Yet to be written</span></p>
1321
1322<h2><a name="_Toc101631104"><span lang=EN-US>NSClientListener.dll</span></a></h2>
1323
1324<p class=MsoNormal><span lang=EN-US>Yet to be written</span></p>
1325
1326<h2><a name="_Toc101631105"><span lang=EN-US>SysTray.dll</span></a></h2>
1327
1328<p class=MsoNormal><span lang=EN-US>A simple module to show an icon in the tray
1329when the service is running this module does not export any check commands.</span></p>
1330
1331<h1><a name="_Toc101631106"><span lang=EN-US>Installation</span></a></h1>
1332
1333<p class=MsoNormal><span lang=EN-US>NSClient++ comes with simple command line
1334option for registering (and deregistering) the service but it does not have a
1335GUI installer.</span></p>
1336
1337<p class=MsoNormal><span lang=EN-US>Thus to install the Client you only need to
1338copy the files to a directory of you choice and then run “NSClient /install”.</span></p>
1339
1340<p class=MsoNormal><span lang=EN-US>Before you start NSClient++ you need to
1341configure the client this is done by editing the configuration file (NSC.ini).
1342The configuration file is a simple text file and is explained in detail under
1343Configuration.</span></p>
1344
1345<p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1346
1347<p class=MsoNormal><span lang=EN-US>To <b>install</b> NSClient++ execute the
1348following command:</span></p>
1349
1350<p class=MsoNormal><i><span lang=EN-US>NSClient++ /install</span></i></p>
1351
1352<p class=MsoNormal><span lang=EN-US>To <b>uninstall</b> NSClient++ execute the
1353following command:</span></p>
1354
1355<p class=MsoNormal><i><span lang=EN-US>NSClient++ /uninstall</span></i></p>
1356
1357<p class=MsoNormal><span lang=EN-US>To <b>start</b> NSClient++ execute the
1358following command:</span></p>
1359
1360<p class=MsoNormal><i><span lang=EN-US>NSClient++ /start</span></i></p>
1361
1362<p class=MsoNormal><span lang=EN-US>To <b>stop</b> NSClient++ execute the
1363following command:</span></p>
1364
1365<p class=MsoNormal><i><span lang=EN-US>NSClient++ /stop</span></i></p>
1366
1367<p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1368
1369<p class=MsoNormal><span lang=EN-US>If you only wish to test it or debug the
1370client you can use the following without installing it first.</span></p>
1371
1372<p class=MsoNormal><i><span lang=EN-US>NSClient++ /test</span></i></p>
1373
1374<h1><a name="_Toc101631107"><span lang=EN-US>Configuration</span></a></h1>
1375
1376<p class=MsoNormal><span lang=EN-US>Configuration is fairly simple and straight
1377forward. Open the configuration file in notepad (or you favorite editor)
1378“notepad &lt;installation path&gt;\NSC.ini”</span></p>
1379
1380<p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1381
1382<p class=MsoNormal><span lang=EN-US>The file has sections (denoted with section
1383name in brackets) and key/value pairs (denoted by key=value). Thus it has the
1384same syntax as pretty much any other INI file in windows.</span></p>
1385
1386<p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1387
1388<p class=MsoNormal><span lang=EN-US>The sections are described in short below.
1389The default configuration file has a lot of examples and comments so make sure
1390you change this before you use NSClient++ as some of the examples might be
1391potential security issues.</span></p>
1392
1393<h2><a name="_Toc101631108"><span lang=EN-US>Log</span></a></h2>
1394
1395<p class=MsoNormal><span lang=EN-US>This section has options for how logging is
1396performed. First off notice that for logging to make sense you need to enable
1397the “FileLogger.dll” module that logs all log data to a text file in the same
1398directory as the NSClient++ binary if you don’t enable any logging module
1399nothing will be logged.</span></p>
1400
1401<p class=MsoNormal><span lang=EN-US>The options you have available here are</span></p>
1402
1403<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
1404 style='border-collapse:collapse;border:none'>
1405 <tr>
1406  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1407  padding:0in 5.4pt 0in 5.4pt'>
1408  <p class=MsoNormal><span lang=EN-US>Option</span></p>
1409  </td>
1410  <td width=109 valign=top style='width:81.8pt;border:solid windowtext 1.0pt;
1411  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1412  <p class=MsoNormal><span lang=EN-US>Default value</span></p>
1413  </td>
1414  <td width=419 valign=top style='width:314.45pt;border:solid windowtext 1.0pt;
1415  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1416  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1417  </td>
1418 </tr>
1419 <tr>
1420  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1421  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1422  <p class=MsoNormal><span lang=EN-US>debug</span></p>
1423  </td>
1424  <td width=109 valign=top style='width:81.8pt;border-top:none;border-left:
1425  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1426  padding:0in 5.4pt 0in 5.4pt'>
1427  <p class=MsoNormal><span lang=EN-US>0</span></p>
1428  </td>
1429  <td width=419 valign=top style='width:314.45pt;border-top:none;border-left:
1430  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1431  padding:0in 5.4pt 0in 5.4pt'>
1432  <p class=MsoNormal><span lang=EN-US>A Boolean value that toggles if debug
1433  information should be logged or not. This can be either 1 or 0.</span></p>
1434  </td>
1435 </tr>
1436 <tr>
1437  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1438  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1439  <p class=MsoNormal><span lang=EN-US>file</span></p>
1440  </td>
1441  <td width=109 valign=top style='width:81.8pt;border-top:none;border-left:
1442  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1443  padding:0in 5.4pt 0in 5.4pt'>
1444  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>nsclient.log</span></p>
1445  </td>
1446  <td width=419 valign=top style='width:314.45pt;border-top:none;border-left:
1447  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1448  padding:0in 5.4pt 0in 5.4pt'>
1449  <p class=MsoNormal><span lang=EN-US>The file to write log data to. If no
1450  directory is used this is relative to the NSClient++ binary.</span></p>
1451  </td>
1452 </tr>
1453</table>
1454
1455<h2><a name="_Toc101631109"><span lang=EN-US>Systray</span></a></h2>
1456
1457<p class=MsoNormal><span lang=EN-US>This section configures the system tray
1458module.</span></p>
1459
1460<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
1461 style='border-collapse:collapse;border:none'>
1462 <tr>
1463  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1464  padding:0in 5.4pt 0in 5.4pt'>
1465  <p class=MsoNormal><span lang=EN-US>Option</span></p>
1466  </td>
1467  <td width=109 valign=top style='width:81.8pt;border:solid windowtext 1.0pt;
1468  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1469  <p class=MsoNormal><span lang=EN-US>Default value</span></p>
1470  </td>
1471  <td width=419 valign=top style='width:314.45pt;border:solid windowtext 1.0pt;
1472  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1473  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1474  </td>
1475 </tr>
1476 <tr>
1477  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1478  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1479  <p class=MsoNormal><span lang=EN-US>defaultCommand</span></p>
1480  </td>
1481  <td width=109 valign=top style='width:81.8pt;border-top:none;border-left:
1482  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1483  padding:0in 5.4pt 0in 5.4pt'>
1484  <p class=MsoNormal><span lang=EN-US>…</span></p>
1485  </td>
1486  <td width=419 valign=top style='width:314.45pt;border-top:none;border-left:
1487  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1488  padding:0in 5.4pt 0in 5.4pt'>
1489  <p class=MsoNormal><span lang=EN-US>A string that will be the default in the
1490  inject command dialog.</span></p>
1491  </td>
1492 </tr>
1493</table>
1494
1495<h2><a name="_Toc101631110"><span lang=EN-US>NSClient</span></a></h2>
1496
1497<p class=MsoNormal><span lang=EN-US>This is the NSClient module configuration
1498options.</span></p>
1499
1500<p class=MsoNormal><b><i><span lang=EN-US>This is subject to change in the near
1501future</span></i></b></p>
1502
1503<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
1504 style='border-collapse:collapse;border:none'>
1505 <tr>
1506  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1507  padding:0in 5.4pt 0in 5.4pt'>
1508  <p class=MsoNormal><span lang=EN-US>Option</span></p>
1509  </td>
1510  <td width=109 valign=top style='width:81.8pt;border:solid windowtext 1.0pt;
1511  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1512  <p class=MsoNormal><span lang=EN-US>Default value</span></p>
1513  </td>
1514  <td width=419 valign=top style='width:314.45pt;border:solid windowtext 1.0pt;
1515  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1516  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1517  </td>
1518 </tr>
1519 <tr>
1520  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1521  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1522  <p class=MsoNormal><span lang=EN-US>port</span></p>
1523  </td>
1524  <td width=109 valign=top style='width:81.8pt;border-top:none;border-left:
1525  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1526  padding:0in 5.4pt 0in 5.4pt'>
1527  <p class=MsoNormal><span lang=EN-US>12489</span></p>
1528  </td>
1529  <td width=419 valign=top style='width:314.45pt;border-top:none;border-left:
1530  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1531  padding:0in 5.4pt 0in 5.4pt'>
1532  <p class=MsoNormal><span lang=EN-US>The port to listen to</span></p>
1533  </td>
1534 </tr>
1535 <tr>
1536  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1537  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1538  <p class=MsoNormal><span lang=EN-US>password</span></p>
1539  </td>
1540  <td width=109 valign=top style='width:81.8pt;border-top:none;border-left:
1541  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1542  padding:0in 5.4pt 0in 5.4pt'>
1543  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1544  </td>
1545  <td width=419 valign=top style='width:314.45pt;border-top:none;border-left:
1546  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1547  padding:0in 5.4pt 0in 5.4pt'>
1548  <p class=MsoNormal><span lang=EN-US>The password that incoming client needs
1549  to authorize themselves by.</span></p>
1550  </td>
1551 </tr>
1552 <tr>
1553  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1554  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1555  <p class=MsoNormal><span lang=EN-US>allowed_hosts</span></p>
1556  </td>
1557  <td width=109 valign=top style='width:81.8pt;border-top:none;border-left:
1558  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1559  padding:0in 5.4pt 0in 5.4pt'>
1560  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1561  </td>
1562  <td width=419 valign=top style='width:314.45pt;border-top:none;border-left:
1563  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1564  padding:0in 5.4pt 0in 5.4pt'>
1565  <p class=MsoNormal><span lang=EN-US>A list (coma separated) with hosts that
1566  are allowed to poll information from NSClient++</span></p>
1567  </td>
1568 </tr>
1569 <tr>
1570  <td width=67 valign=top style='width:50.15pt;border:solid windowtext 1.0pt;
1571  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1572  <p class=MsoNormal><span lang=EN-US>use_ssl</span></p>
1573  </td>
1574  <td width=109 valign=top style='width:81.8pt;border-top:none;border-left:
1575  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1576  padding:0in 5.4pt 0in 5.4pt'>
1577  <p class=MsoNormal><span lang=EN-US>0</span></p>
1578  </td>
1579  <td width=419 valign=top style='width:314.45pt;border-top:none;border-left:
1580  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1581  padding:0in 5.4pt 0in 5.4pt'>
1582  <p class=MsoNormal><span lang=EN-US>Boolean value to toggle SSL encryption.
1583  This is not yet supported in any client I know of but as the underlying
1584  structure (NRPE) supports it I thought Id might add it if someone wants to
1585  update check_nt to support SSL.</span></p>
1586  <p class=MsoNormal><b><span lang=EN-US>Not implemented in this version</span></b></p>
1587  </td>
1588 </tr>
1589</table>
1590
1591<h2><a name="_Toc101631111"><span lang=EN-US>NRPE</span></a></h2>
1592
1593<p class=MsoNormal><span lang=EN-US>This is configuration for the NRPE module
1594that controls how the NRPE listener operates. </span></p>
1595
1596<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
1597 style='border-collapse:collapse;border:none'>
1598 <tr>
1599  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1600  padding:0in 5.4pt 0in 5.4pt'>
1601  <p class=MsoNormal><span lang=EN-US>Option</span></p>
1602  </td>
1603  <td width=107 valign=top style='width:80.4pt;border:solid windowtext 1.0pt;
1604  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1605  <p class=MsoNormal><span lang=EN-US>Default value</span></p>
1606  </td>
1607  <td width=406 valign=top style='width:304.5pt;border:solid windowtext 1.0pt;
1608  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1609  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1610  </td>
1611 </tr>
1612 <tr>
1613  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1614  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1615  <p class=MsoNormal><span lang=EN-US>port</span></p>
1616  </td>
1617  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1618  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1619  padding:0in 5.4pt 0in 5.4pt'>
1620  <p class=MsoNormal><span lang=EN-US>5666</span></p>
1621  </td>
1622  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1623  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1624  padding:0in 5.4pt 0in 5.4pt'>
1625  <p class=MsoNormal><span lang=EN-US>The port to listen to</span></p>
1626  </td>
1627 </tr>
1628 <tr>
1629  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1630  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1631  <p class=MsoNormal><span lang=EN-US>allowed_hosts</span></p>
1632  </td>
1633  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1634  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1635  padding:0in 5.4pt 0in 5.4pt'>
1636  <p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1637  </td>
1638  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1639  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1640  padding:0in 5.4pt 0in 5.4pt'>
1641  <p class=MsoNormal><span lang=EN-US>A list (coma separated) with hosts that
1642  are allowed to poll information from NSClient++</span></p>
1643  </td>
1644 </tr>
1645 <tr>
1646  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1647  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1648  <p class=MsoNormal><span lang=EN-US>use_ssl</span></p>
1649  </td>
1650  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1651  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1652  padding:0in 5.4pt 0in 5.4pt'>
1653  <p class=MsoNormal><span lang=EN-US>1</span></p>
1654  </td>
1655  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1656  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1657  padding:0in 5.4pt 0in 5.4pt'>
1658  <p class=MsoNormal><span lang=EN-US>Boolean value to toggle SSL encryption on
1659  the socket connection</span></p>
1660  </td>
1661 </tr>
1662 <tr>
1663  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1664  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1665  <p class=MsoNormal><span lang=EN-US>command_timeout</span></p>
1666  </td>
1667  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1668  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1669  padding:0in 5.4pt 0in 5.4pt'>
1670  <p class=MsoNormal><span lang=EN-US>60</span></p>
1671  </td>
1672  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1673  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1674  padding:0in 5.4pt 0in 5.4pt'>
1675  <p class=MsoNormal><span lang=EN-US>The maximum time in seconds that a
1676  command can execute. (if more then this execution will be aborted).</span></p>
1677  <p class=MsoNormal><b><span lang=EN-US>NOTICE</span></b><span lang=EN-US>
1678  this only affects external commands not internal ones.</span></p>
1679  </td>
1680 </tr>
1681 <tr>
1682  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1683  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1684  <p class=MsoNormal><span lang=EN-US>allow_arguments</span></p>
1685  </td>
1686  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1687  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1688  padding:0in 5.4pt 0in 5.4pt'>
1689  <p class=MsoNormal><span lang=EN-US>0</span></p>
1690  </td>
1691  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1692  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1693  padding:0in 5.4pt 0in 5.4pt'>
1694  <p class=MsoNormal><span lang=EN-US>A Boolean flag to determine if arguments
1695  are accepted on the incoming socket. If arguments are not accepted you can
1696  still use external commands that need arguments but you have to define them
1697  in the NRPE handlers below. This is similar to the NRPE “dont_blame_nrpe”
1698  option.</span></p>
1699  </td>
1700 </tr>
1701 <tr>
1702  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1703  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1704  <p class=MsoNormal><span lang=EN-US>allow_nasty_meta_chars</span></p>
1705  </td>
1706  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1707  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1708  padding:0in 5.4pt 0in 5.4pt'>
1709  <p class=MsoNormal><span lang=EN-US>0</span></p>
1710  </td>
1711  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1712  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1713  padding:0in 5.4pt 0in 5.4pt'>
1714  <p class=MsoNormal><span lang=EN-US>Allow NRPE execution to have “nasty” meta
1715  characters that might affect execution of external commands (things like &gt;
1716  “ etc).</span></p>
1717  </td>
1718 </tr>
1719</table>
1720
1721<h2><a name="_Toc101631112"><span lang=EN-US>NRPE Handlers</span></a></h2>
1722
1723<p class=MsoNormal><span lang=EN-US>This is a list of handlers for NRPE
1724execution this can of course be used by any module (such as NSClient) but for
1725historical reasons they are located in this section especially as NRPE plug-in
1726is the one that does the actual execution.</span></p>
1727
1728<p class=MsoNormal><span lang=EN-US>The handlers can have two different
1729syntaxes:</span></p>
1730
1731<p class=MsoNormal><span lang=EN-US>Either “command[my_command]=/some/executable”
1732or “my_command=/some/executable” The latter is the preferred way as it is
1733shorter.</span></p>
1734
1735<h2><a name="_Toc101631113"><span lang=EN-US>Check System</span></a></h2>
1736
1737<p class=MsoNormal><span lang=EN-US>Here you can set various options to
1738configure the Syetem Check module.</span></p>
1739
1740<table class=MsoTableGrid border=1 cellspacing=0 cellpadding=0
1741 style='border-collapse:collapse;border:none'>
1742 <tr>
1743  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1744  padding:0in 5.4pt 0in 5.4pt'>
1745  <p class=MsoNormal><span lang=EN-US>Option</span></p>
1746  </td>
1747  <td width=107 valign=top style='width:80.4pt;border:solid windowtext 1.0pt;
1748  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1749  <p class=MsoNormal><span lang=EN-US>Default value</span></p>
1750  </td>
1751  <td width=406 valign=top style='width:304.5pt;border:solid windowtext 1.0pt;
1752  border-left:none;padding:0in 5.4pt 0in 5.4pt'>
1753  <p class=MsoNormal><span lang=EN-US>Description</span></p>
1754  </td>
1755 </tr>
1756 <tr>
1757  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1758  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1759  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CPUBufferSize</span></p>
1760  </td>
1761  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1762  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1763  padding:0in 5.4pt 0in 5.4pt'>
1764  <p class=MsoNormal><span lang=EN-US>1h</span></p>
1765  </td>
1766  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1767  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1768  padding:0in 5.4pt 0in 5.4pt'>
1769  <p class=MsoNormal><span lang=EN-US>The time to store CPU load. This means
1770  you can get averaged values this far back in time. The downside is the buffer
1771  might use a lot of memory if the check resolution is high.</span></p>
1772  </td>
1773 </tr>
1774 <tr>
1775  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1776  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1777  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CheckResolution</span></p>
1778  </td>
1779  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1780  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1781  padding:0in 5.4pt 0in 5.4pt'>
1782  <p class=MsoNormal><span lang=EN-US>10</span></p>
1783  </td>
1784  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1785  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1786  padding:0in 5.4pt 0in 5.4pt'>
1787  <p class=MsoNormal><span lang=EN-US>Time between checks in 1/10 of seconds.
1788  That means a value of 10 means check every second. A value of 100 means check
1789  every 10 seconds and so on.</span></p>
1790  </td>
1791 </tr>
1792 <tr>
1793  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1794  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1795  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CounterPageLimit</span></p>
1796  </td>
1797  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1798  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1799  padding:0in 5.4pt 0in 5.4pt'>
1800  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>\\\\.\\Memory\\Commit
1801  Limit</span></p>
1802  </td>
1803  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1804  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1805  padding:0in 5.4pt 0in 5.4pt'>
1806  <p class=MsoNormal><span lang=EN-US>Counter to use to check upper memory
1807  limit.</span></p>
1808  </td>
1809 </tr>
1810 <tr>
1811  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1812  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1813  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CounterPage</span></p>
1814  </td>
1815  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1816  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1817  padding:0in 5.4pt 0in 5.4pt'>
1818  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>\\\\.\\Memory\\Committed
1819  Bytes</span></p>
1820  </td>
1821  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1822  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1823  padding:0in 5.4pt 0in 5.4pt'>
1824  <p class=MsoNormal><span lang=EN-US>Counter to use to check current memory
1825  usage.</span></p>
1826  </td>
1827 </tr>
1828 <tr>
1829  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1830  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1831  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CounterUptime</span></p>
1832  </td>
1833  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1834  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1835  padding:0in 5.4pt 0in 5.4pt'>
1836  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>\\\\.\\System\\System
1837  Up Time</span></p>
1838  </td>
1839  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1840  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1841  padding:0in 5.4pt 0in 5.4pt'>
1842  <p class=MsoNormal><span lang=EN-US>Counter to use to check the uptime of the
1843  system.</span></p>
1844  </td>
1845 </tr>
1846 <tr>
1847  <td width=106 valign=top style='width:79.5pt;border:solid windowtext 1.0pt;
1848  border-top:none;padding:0in 5.4pt 0in 5.4pt'>
1849  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>CounterCPU</span></p>
1850  </td>
1851  <td width=107 valign=top style='width:80.4pt;border-top:none;border-left:
1852  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1853  padding:0in 5.4pt 0in 5.4pt'>
1854  <p class=MsoNormal><span style='font-size:10.0pt;font-family:"Courier New"'>\\\\.\\Processor(_total)\\%
1855  Processor Time</span></p>
1856  </td>
1857  <td width=406 valign=top style='width:304.5pt;border-top:none;border-left:
1858  none;border-bottom:solid windowtext 1.0pt;border-right:solid windowtext 1.0pt;
1859  padding:0in 5.4pt 0in 5.4pt'>
1860  <p class=MsoNormal><span lang=EN-US>Counter to use for CPU load.</span></p>
1861  </td>
1862 </tr>
1863</table>
1864
1865<h2><a name="_Toc101631114"><span lang=EN-US>modules</span></a></h2>
1866
1867<p class=MsoNormal><span lang=EN-US>This is a list of modules to load at
1868startup. All the modules included in this list has to be NSClient++ modules and
1869located in the modules subdirectory. This is in effect the list of plug-ins
1870that will be available as the service is running.</span></p>
1871
1872<p class=MsoNormal><span lang=EN-US>A good idea here is to disable all modules
1873you don’t actually use for two reasons. One less code equals less potential
1874security holes and two less modules means less resource drain.</span></p>
1875
1876<p class=MsoNormal><span lang=EN-US>&nbsp;</span></p>
1877
1878</div>
1879
1880</body>
1881
1882</html>
Note: See TracBrowser for help on using the repository browser.