source: nscp/trunk/docs/CheckHelpers/index.html @ 7b04f88

Last change on this file since 7b04f88 was 7b04f88, checked in by Michael Medin <michael@…>, 8 years ago

2005-05-15 MickeM

+ Added NRPE support for checkCounter
+ Updated documentation

  • Make check commands ignore case + Added CheckHelpers module to alter the result of various check and similar things

2005-05-14 MickeM

+ Added support for Volumes (CheckDisk)
+ Added support for checking all drives of a certain kind
+ Added support for altering filter (makes it posible to check removale drives)
+ Created webpage and better documentation
  • Property mode set to 100644
File size: 5.9 KB
Line 
1<html>
2
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<title>CheckDisk</title>
6<link rel="stylesheet" type="text/css" href="../nscplus.css">
7</head>
8
9<body>
10
11<div id="content" class="documentContent">
12        <h1>CheckHelpers.dll</h1>
13        <p>The CheckHelpers module has various helper function to alter other checks
14        in various ways. This module does not check anything by it self.</p>
15        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table4">
16                <tr>
17                        <th valign="top">Command </th>
18                        <th valign="top">Description </th>
19                </tr>
20                <tr>
21                        <td valign="top">CheckAlwaysOK</td>
22                        <td valign="top">Alter the retun code of another check to always return
23                        OK.</td>
24                </tr>
25                <tr>
26                        <td valign="top">CheckAlwaysCRITICAL</td>
27                        <td valign="top">Alter the retun code of another check to always return
28                        CRITICAL.</td>
29                </tr>
30                <tr>
31                        <td valign="top">CheckAlwaysWARNING</td>
32                        <td valign="top">Alter the retun code of another check to always return
33                        WARNING.</td>
34                </tr>
35                <tr>
36                        <td valign="top">CheckMultiple</td>
37                        <td valign="top">Runs multiple checks and returns the worsta state.
38                        Usefull for minimizing network traffic and command defenitions.</td>
39                </tr>
40        </table>
41        <h2>Configuration</h2>
42        <p><i>This module has no configuration directives.</i></p>
43        <h2>CheckAlwaysOK</h2>
44        <p>Runs another check and aters the return state to always return OK.</p>
45        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table5">
46                <tr>
47                        <th valign="top">Option </th>
48                        <th valign="top">Values </th>
49                        <th valign="top">Description </th>
50                </tr>
51                <tr>
52                        <td valign="top"><i>None</i></td>
53                        <td valign="top"><i>None</i></td>
54                        <td valign="top"><i>None</i></td>
55                </tr>
56        </table>
57        <p>This command has no options instead everything is inject as a new command.
58        Notice that this command does not alter the return string so if a check (as
59        most do) prints WARNING that will still remain, only the return state is altered.
60        The return state is what Nagios will use to determine state.</p>
61        <h3>Examples</h3>
62        <div class="example">
63                <ul>
64                        <li>
65                        <p>Run the sample check from CheckDisk but alter the return state. Notice
66                        that WARNING is still printed, yet Nagios will interpret this as an
67                        OK state.</p>
68                        <p><code>CheckAlwaysOK CheckFileSize ShowAll MaxWarn=1024M MaxCrit=4096M
69                        File:WIN=c:\WINDOWS\*.*</code></p>
70                        <p><code>WARNING: WIN: 2G (2325339822B)|WIN=2325339822;1073741824;4294967296</code></p>
71                        </li>
72                </ul>
73        </div>
74        <h2>CheckAlwaysCRITICAL</h2>
75        <p>Runs another check and ater the return state to always return CRITICAL.</p>
76        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table5">
77                <tr>
78                        <th valign="top">Option </th>
79                        <th valign="top">Values </th>
80                        <th valign="top">Description </th>
81                </tr>
82                <tr>
83                        <td valign="top"><i>None</i></td>
84                        <td valign="top"><i>None</i></td>
85                        <td valign="top"><i>None</i></td>
86                </tr>
87        </table>
88        <p>This command has no options instead everything is inject as a new command.
89        Notice that this command does not alter the return string so if a check (as
90        most do) prints WARNING that will still remain, only the return state is altered.
91        The return state is what Nagios will use to determine state.</p>
92        <h3>Examples</h3>
93        <div class="example">
94                <ul>
95                        <li>
96                        <p>Run the sample check from CheckDisk but alter the return state. Notice
97                        that WARNING is still printed, yet Nagios will interpret this as a critical
98                        state.</p>
99                        <p><code>CheckAlwaysCRITICAL CheckFileSize ShowAll MaxWarn=1024M MaxCrit=4096M
100                        File:WIN=c:\WINDOWS\*.*</code></p>
101                        <p><code>WARNING: WIN: 2G (2325339822B)|WIN=2325339822;1073741824;4294967296</code></p>
102                        </li>
103                </ul>
104        </div>
105        <h2>CheckAlwaysWARNING</h2>
106        <p>Runs another check and ater the return state to always return WARNING.</p>
107        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table5">
108                <tr>
109                        <th valign="top">Option </th>
110                        <th valign="top">Values </th>
111                        <th valign="top">Description </th>
112                </tr>
113                <tr>
114                        <td valign="top"><i>None</i></td>
115                        <td valign="top"><i>None</i></td>
116                        <td valign="top"><i>None</i></td>
117                </tr>
118        </table>
119        <p>This command has no options instead everything is inject as a new command.
120        Notice that this command does not alter the return string so if a check (as
121        most do) prints WARNING that will still remain, only the return state is altered.
122        The return state is what Nagios will use to determine state.</p>
123        <h3>Examples</h3>
124        <div class="example">
125                <ul>
126                        <li>
127                        <p>Run the sample check from CheckDisk but alter the return state. Notice
128                        that WARNING is still printed, yet Nagios will interpret this as an
129                        warning state.</p>
130                        <p><code>CheckAlwaysOK CheckFileSize ShowAll MaxWarn=1024M MaxCrit=4096M
131                        File:WIN=c:\WINDOWS\*.*</code></p>
132                        <p><code>WARNING: WIN: 2G (2325339822B)|WIN=2325339822;1073741824;4294967296</code></p>
133                        </li>
134                </ul>
135        </div>
136        <h2>CheckMultiple</h2>
137        <p>Runs multiple checks and returns the worst state. It allows you to check an entire system in one go.</p>
138        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table5">
139                <tr>
140                        <th valign="top">Option </th>
141                        <th valign="top">Values </th>
142                        <th valign="top">Description </th>
143                </tr>
144                <tr>
145                        <td valign="top">command</td>
146                        <td valign="top">The command to run</td>
147                        <td valign="top">A command to execute, you can have any number of
148                        this option.</td>
149                </tr>
150        </table>
151        <h3>Examples</h3>
152        <div class="example">
153                <ul>
154                        <li>
155                        <p>Run two checks (CheckDriveSize and ChEckMeM) and return the worst state. Performance data and
156                        message is collected and concatenated.</p>
157                        <p><code>CheckMultiple command=CheckDriveSize MaxWarn=1M MaxCrit=2M Drive=c:\\volumne_test\\ command=ChEckMeM MaxWarn=80% MaxCrit=90%</code></p>
158                        <p><code>CRITICAL: c:\volumne_test\: 3M (4193280B) > critical, OK memory within bounds.|c:\volumne_test\=4193280;1024K (1048576B);2M (2097152B); page=31% 80%;90%;</code></p>
159                        </li>
160                </ul>
161        </div>
162</div>
163
164</body>
165
166</html>
Note: See TracBrowser for help on using the repository browser.