source: nscp/docs/CheckDisk/index.html @ e655f61

0.4.00.4.10.4.2stable
Last change on this file since e655f61 was e655f61, 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: 7.0 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>CheckDisk.dll</h1>
13        <p>The CheckDisk module has various disk related checks currently focusing on
14        size. But hopefully it will be extended with date existance and many other disk
15        related checks in the furture. Feel free to request checks that you need.</p>
16        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table4">
17                <tr>
18                        <th valign="top">Command </th>
19                        <th valign="top">Description </th>
20                </tr>
21                <tr>
22                        <td valign="top">CheckFileSize </td>
23                        <td valign="top">Check the size of one or more files or directories.
24                        </td>
25                </tr>
26                <tr>
27                        <td valign="top">CheckDriveSize </td>
28                        <td valign="top">Check the size of one or more Drives </td>
29                </tr>
30        </table>
31        <h2>Configuration</h2>
32        <p><i>This module has no configuration directives.</i></p>
33        <h2>CheckFileSize</h2>
34        <p>This check does a recursive size calculation of the directory (or file) specified.
35        A request has one or more options described in the table below. </p>
36        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table5">
37                <tr>
38                        <th valign="top">Option </th>
39                        <th valign="top">Values </th>
40                        <th valign="top">Description </th>
41                </tr>
42                <tr>
43                        <td valign="top">MaxWarn </td>
44                        <td valign="top">Size with optional postfix</td>
45                        <td valign="top">The maximum size the directory is allowed before a
46                        warning state is returned. </td>
47                </tr>
48                <tr>
49                        <td valign="top">MaxCrit </td>
50                        <td valign="top">Size with optional postfix </td>
51                        <td valign="top">The maximum size the directory is allowed before a
52                        critical state is returned. </td>
53                </tr>
54                <tr>
55                        <td valign="top">MinWarn </td>
56                        <td valign="top">Size with optional postfix </td>
57                        <td valign="top">The minimum size the directory is allowed before a
58                        warning state is returned. </td>
59                </tr>
60                <tr>
61                        <td valign="top">MinCrit </td>
62                        <td valign="top">Size with optional postfix </td>
63                        <td valign="top">The minimum size the directory is allowed before a
64                        critical state is returned. </td>
65                </tr>
66                <tr>
67                        <td valign="top">ShowAll </td>
68                        <td valign="top"><i>None</i> </td>
69                        <td valign="top">A Boolean flag to show size of directories that are
70                        not in an alarm state. If this is not specified only drives with an
71                        alarm state will be listed in the resulting string. </td>
72                </tr>
73                <tr>
74                        <td valign="top">File </td>
75                        <td valign="top">File or directory name </td>
76                        <td valign="top">The name of the file or directory that should have
77                        its size calculated. Notice that large directory structures will take
78                        a long time to check. </td>
79                </tr>
80                <tr>
81                        <td valign="top">
82                        <p>File:&lt;alias&gt;</p>
83                        </td>
84                        <td valign="top">
85                        <p>File or directory name</p>
86                        </td>
87                        <td valign="top">
88                        <p>Same as the file option but using a short alias in the returned data.</p>
89                        </td>
90                </tr>
91        </table>
92        <p>The “Size with optional postfix” is a way to simply specify large sizes by
93        adding unit postfix. The avalible postfixes are B for Byte, K for KiloByte,
94        M for MegaByte and finally G for GigaByte. </p>
95        <h3>Examples</h3>
96        <div class="example">
97                <ul>
98                        <li>
99                        <p>Check the size of the windows directory and make sure it stays
100                        below 1 gigabyte:</p>
101                        <p><code>CheckFileSize ShowAll MaxWarn=1024M MaxCrit=4096M File:WIN=c:\WINDOWS\*.*</code></p>
102                        <p><code>WARNING: WIN: 2G (2325339822B)|WIN=2325339822;1073741824;4294967296</code></p>
103                        </li>
104                        <li>
105                        <p>Check the size of the pagefile.sys and make sure it stays
106                        above 1 gigabyte:</p>
107                        <p><code>CheckFileSize ShowAll MinWarn=1G MinCrit=512M File=c:\pagefile.sys</code></p>
108                        <p><code>OK: c:\pagefile.sys: 1G (1610612736B)</code></p>
109                        </li>
110                </ul>
111        </div>
112        <h2>CheckDriveSize</h2>
113        <table class="MsoNormalTable" border="0" cellspacing="0" cellpadding="0" id="table6">
114                <tr>
115                        <th valign="top">Option </th>
116                        <th valign="top">Values </th>
117                        <th valign="top">Description </td>
118                        </th>
119                </tr>
120                <tr>
121                        <td valign="top">MaxWarn&lt; </td>
122                        <td valign="top">Size with optional postfix (g, m, k, b, %)</td>
123                        <td valign="top">The maximum size the directory is allowed before a
124                        warning state is returned.</td>
125                </tr>
126                <tr>
127                        <td valign="top">MaxCrit </td>
128                        <td valign="top">Size with optional postfix (g, m, k, b, %) </td>
129                        <td valign="top">The maximum size the directory is allowed before a
130                        critical state is returned. </td>
131                </tr>
132                <tr>
133                        <td valign="top">MinWarn </td>
134                        <td valign="top">Size with optional postfix (g, m, k, b, %) </td>
135                        <td valign="top">The minimum size the directory is allowed before a
136                        warning state is returned. </td>
137                </tr>
138                <tr>
139                        <td valign="top">MinCrit </td>
140                        <td valign="top">Size with optional postfix (g, m, k, b, %) </td>
141                        <td valign="top">The minimum size the directory is allowed before a
142                        critical state is returned. </td>
143                </tr>
144                <tr>
145                        <td valign="top">ShowAll </td>
146                        <td valign="top"><i>None</i> </td>
147                        <td valign="top">
148                        <p>A Boolean flag to show size of directories that are not in an alarm
149                        state. If this is not specified only drives with an alarm state will
150                        be listed in the resulting string.</p>
151                        </td>
152                </tr>
153                <tr>
154                        <td valign="top">Drive </td>
155                        <td valign="top">A Drive letter or the path of a mounted Volume </td>
156                        <td valign="top">The letter of the drive to check. Notice that the drive
157                        has to be a fixed drive. </td>
158                </tr>
159                <tr>
160                        <td valign="top">FilterType</td>
161                        <td valign="top">FIXED, CDROM, REMOVABLE</td>
162                        <td valign="top">Filter for drive type to prevent checking drives of
163                        certain kinds (most useful when using CheckAll). The default is
164                        FIXED</td>
165                </tr>
166                <tr>
167                        <td valign="top">CheckAll</td>
168                        <td valign="top"><i>None</i></td>
169                        <td valign="top">Check all available drives</td>
170                </tr>
171        </table>
172        <p>The “Size with optional postfix” is a way to simply specify large sizes by
173        adding unit postfix. The availible postfixes are B for Byte, K for KiloByte,
174        M for MegaByte, G for GigaByte and finally % for percent free space. </p>
175        <h3>Examples</h3>
176        <div class="example">
177                <ul>
178                        <li>
179                        <p>Check the size of C:\ and make sure it has 50% free space:</p>
180                        <p><code>CheckDriveSize ShowAll MaxWarn=50% MaxWarn=75% Drive=c:\</code></p>
181                        <p><code>OK: c:: 63G (68374007808B)|c:=85% 50;75;</code></p>
182                        </li>
183                        <li>
184                        <p>To check the size of mounted volume c:\volumne_test and make sure it has 1M free space</p>
185                        <p><code>CheckDriveSize ShowAll MaxWarn=1M MaxCrit=2M Drive="c:\\volumne_test\\"</code></p>
186                        <p><code>CRITICAL: c:\volumne_test\: 3M (4193280B)|c:\volumne_test\=4193280;0;0;</code></p>
187                        </li>
188                        <li>
189                        <p>To check the size of all fixed and network drives and make sure they are at least 50% full</p>
190                        <p><code>CheckDriveSize -a MinWarn=50% MinCrit=25% CheckAll FilterType=FIXED FilterType=REMOTE</code></p>
191                        <p><code>WARNING: X:\: 28% < warning|C:\=84% 50%;25%; X:\=28% 50%;25%; Y:\=98% 50%;25%;</code></p>
192                        </li>
193                </ul>
194        </div>
195</div>
196</body>
197
198</html>
Note: See TracBrowser for help on using the repository browser.