]>
Commit | Line | Data |
---|---|---|
832b75ed | 1 | .ig |
34ad0c5f | 2 | Copyright (C) 2002-8 Bruce Allen <smartmontools-support@lists.sourceforge.net> |
832b75ed | 3 | |
a23d5117 | 4 | $Id: smartd.8.in 3057 2010-02-03 20:56:41Z chrfranke $ |
832b75ed GG |
5 | |
6 | This program is free software; you can redistribute it and/or modify | |
7 | it under the terms of the GNU General Public License as published by | |
8 | the Free Software Foundation; either version 2, or (at your option) | |
9 | any later version. | |
10 | ||
11 | You should have received a copy of the GNU General Public License (for | |
12 | example COPYING); if not, write to the Free Software Foundation, Inc., | |
13 | 675 Mass Ave, Cambridge, MA 02139, USA. | |
14 | ||
15 | This code was originally developed as a Senior Thesis by Michael | |
16 | Cornwell at the Concurrent Systems Laboratory (now part of the Storage | |
17 | Systems Research Center), Jack Baskin School of Engineering, | |
18 | University of California, Santa Cruz. http://ssrc.soe.ucsc.edu/ | |
19 | .. | |
20 | .TH SMARTD 8 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE | |
21 | .SH NAME | |
22 | \fBsmartd\fP \- SMART Disk Monitoring Daemon | |
23 | ||
24 | .SH SYNOPSIS | |
25 | .B smartd [options] | |
26 | ||
27 | .SH FULL PATH | |
28 | .B /usr/local/sbin/smartd | |
29 | ||
30 | .SH PACKAGE VERSION | |
31 | CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME | |
32 | ||
33 | .SH DESCRIPTION | |
34 | \fBsmartd\fP is a daemon that monitors the Self-Monitoring, Analysis | |
35 | and Reporting Technology (SMART) system built into many ATA-3 and | |
36 | later ATA, IDE and SCSI-3 hard drives. The purpose of SMART is to | |
37 | monitor the reliability of the hard drive and predict drive failures, | |
38 | and to carry out different types of drive self-tests. This version of | |
39 | \fBsmartd\fP is compatible with ATA/ATAPI-7 and earlier standards (see | |
40 | \fBREFERENCES\fP below). | |
41 | ||
42 | \fBsmartd\fP will attempt to enable SMART monitoring on ATA devices | |
43 | (equivalent to \fBsmartctl -s on\fP) and polls these and SCSI devices | |
44 | every 30 minutes (configurable), logging SMART errors and changes of | |
45 | SMART Attributes via the SYSLOG interface. The default location for | |
46 | these SYSLOG notifications and warnings is \fB/var/log/messages\fP. | |
47 | To change this default location, please see the \fB\'-l\'\fP | |
48 | command-line option described below. | |
49 | ||
50 | In addition to logging to a file, \fBsmartd\fP can also be configured | |
51 | to send email warnings if problems are detected. Depending upon the | |
52 | type of problem, you may want to run self\-tests on the disk, back up | |
53 | the disk, replace the disk, or use a manufacturer\'s utility to force | |
54 | reallocation of bad or unreadable disk sectors. If disk problems are | |
55 | detected, please see the \fBsmartctl\fP manual page and the | |
56 | \fBsmartmontools\fP web page/FAQ for further guidance. | |
57 | ||
58 | If you send a \fBUSR1\fP signal to \fBsmartd\fP it will immediately | |
59 | check the status of the disks, and then return to polling the disks | |
60 | every 30 minutes. See the \fB\'\-i\'\fP option below for additional | |
61 | details. | |
62 | ||
63 | \fBsmartd\fP can be configured at start-up using the configuration | |
64 | file \fB/usr/local/etc/smartd.conf\fP (Windows: \fB./smartd.conf\fP). | |
65 | If the configuration file is subsequently modified, \fBsmartd\fP | |
66 | can be told to re-read the configuration file by sending it a | |
67 | \fBHUP\fP signal, for example with the command: | |
68 | .fi | |
69 | \fBkillall -HUP smartd\fP. | |
70 | .fi | |
71 | (Windows: See NOTES below.) | |
72 | ||
73 | On startup, if \fBsmartd\fP finds a syntax error in the configuration | |
74 | file, it will print an error message and then exit. However if | |
75 | \fBsmartd\fP is already running, then is told with a \fBHUP\fP signal | |
76 | to re-read the configuration file, and then find a syntax error in | |
77 | this file, it will print an error message and then continue, ignoring | |
78 | the contents of the (faulty) configuration file, as if the \fBHUP\fP | |
79 | signal had never been received. | |
80 | ||
81 | When \fBsmartd\fP is running in debug mode, the \fBINT\fP signal | |
82 | (normally generated from a shell with CONTROL\-C) is treated in the | |
83 | same way as a \fBHUP\fP signal: it makes \fBsmartd\fP reload its | |
84 | configuration file. To exit \fBsmartd\fP use CONTROL-\e | |
85 | (Cygwin: 2x CONTROL\-C, Windows: CONTROL\-Break). | |
86 | ||
87 | On startup, in the absence of the configuration file | |
88 | \fB/usr/local/etc/smartd.conf\fP, the \fBsmartd\fP daemon first scans for all | |
89 | devices that support SMART. The scanning is done as follows: | |
90 | .IP \fBLINUX:\fP 9 | |
91 | Examine all entries \fB"/dev/hd[a-t]"\fP for IDE/ATA | |
92 | devices, and \fB"/dev/sd[a-z]"\fP for SCSI devices. | |
93 | .IP \fBFREEBSD:\fP 9 | |
eb07ddf2 | 94 | Authoritative list of disk devices is obtained from SCSI (CAM) and ATA subsystems. |
832b75ed GG |
95 | .IP \fBNETBSD/OPENBSD:\fP 9 |
96 | Authoritative list of disk devices is obtained from sysctl | |
97 | \'hw.disknames\'. | |
98 | .IP \fBSOLARIS:\fP 9 | |
99 | Examine all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk | |
100 | devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices. | |
101 | .IP \fBDARWIN:\fP 9 | |
102 | The IOService plane is scanned for ATA block storage devices. | |
a37e7145 GG |
103 | .IP \fBWINDOWS\ 9x/ME\fP: 9 |
104 | Examine all entries \fB"/dev/hd[a-d]"\fP (bitmask | |
105 | from "\\\\.\\SMARTVSD") for IDE/ATA devices. | |
106 | Examine all entries \fB"/dev/scsi[0\-9][0\-f]"\fP for SCSI devices | |
ba59cff1 | 107 | on ASPI adapter 0\-9, ID 0\-15. |
a37e7145 GG |
108 | .IP \fBWINDOWS\ NT4/2000/XP/2003/Vista\fP: 9 |
109 | Examine all entries \fB"/dev/sd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]") | |
110 | for IDE/(S)ATA and SCSI disk devices | |
111 | ||
4d59bff9 | 112 | If a 3ware 9000 controller is installed, examine all entries |
a37e7145 GG |
113 | \fB"/dev/sdX,N"\fP for the first logical drive (\'unit\' |
114 | \fB"/dev/sdX"\fP) and all physical disks (\'ports\' \fB",N"\fP) | |
4d59bff9 | 115 | detected behind this controller. Same for a second controller if present. |
832b75ed | 116 | .IP \fBCYGWIN\fP: 9 |
a37e7145 | 117 | See "WINDOWS NT4/2000/XP/2003/Vista" above. |
832b75ed GG |
118 | .IP \fBOS/2,eComStation\fP: 9 |
119 | Use the form \fB"/dev/hd[a\-z]"\fP for IDE/ATA devices. | |
120 | .PP | |
121 | \fBsmartd\fP then monitors | |
122 | for \fIall\fP possible SMART errors (corresponding to the \fB\'\-a\'\fP | |
123 | Directive in the configuration file; see \fBCONFIGURATION FILE\fP | |
124 | below). | |
125 | ||
126 | .SH | |
127 | OPTIONS | |
128 | Long options are not supported on all systems. Use \fB\'smartd | |
129 | \-h\'\fP to see the available options. | |
2127e193 | 130 | |
832b75ed | 131 | .TP |
2127e193 GI |
132 | .B \-A PREFIX, \-\-attributelog=PREFIX |
133 | [NEW EXPERIMENTAL SMARTD FEATURE] [ATA ONLY] | |
134 | Writes \fBsmartd\fP attribute information (normalized and raw attribute values) | |
135 | to files \'PREFIX\'\'MODEL\-SERIAL.ata.csv\'. At each check cycle attributes | |
136 | are logged as a line of semicolon separated triplets of the form | |
137 | "attribute-ID;attribute-norm-value;attribute-raw-value;". Each line is | |
138 | led by a date string of the form "yyyy-mm-dd HH:MM:SS" (in UTC). | |
139 | ||
140 | .\" BEGIN ENABLE_ATTRIBUTELOG | |
141 | If this option is not specified, attribute information is written to files | |
142 | \'/usr/local/var/lib/smartmontools/attrlog.MODEL\-SERIAL.ata.csv\'. | |
143 | To disable attribute log files, specify this option with an empty string | |
144 | argument: \'-A ""\'. | |
145 | .\" END ENABLE_ATTRIBUTELOG | |
146 | MODEL and SERIAL are build from drive identify information, invalid | |
147 | characters are replaced by underline. | |
148 | ||
149 | If the PREFIX has the form \'/path/dir/\' (e.g. \'/var/lib/smartd/\'), then | |
150 | files \'MODEL\-SERIAL.ata.csv\' are created in directory \'/path/dir\'. | |
151 | If the PREFIX has the form \'/path/name\' (e.g. \'/var/lib/misc/attrlog\-\'), | |
152 | then files 'nameMODEL\-SERIAL.ata.csv' are created in directory '/path/'. | |
153 | The path must be absolute, except if debug mode is enabled. | |
832b75ed | 154 | |
2127e193 GI |
155 | .TP |
156 | .B \-B [+]FILE, \-\-drivedb=[+]FILE | |
157 | [NEW EXPERIMENTAL SMARTD FEATURE] Read the drive database from FILE. | |
158 | The new database replaces the built in database by default. If \'+\' is | |
159 | specified, then the new entries prepend the built in entries. | |
bed94269 | 160 | Please see the \fBsmartctl\fP(8) man page for further details. |
2127e193 GI |
161 | |
162 | .TP | |
163 | .B \-c FILE, \-\-configfile=FILE | |
832b75ed GG |
164 | Read \fBsmartd\fP configuration Directives from FILE, instead of from |
165 | the default location \fB/usr/local/etc/smartd.conf\fP (Windows: \fB./smartd.conf\fP). | |
166 | If FILE does \fBnot\fP exist, then \fBsmartd\fP will print an error | |
167 | message and exit with nonzero status. Thus, \'\-c /usr/local/etc/smartd.conf\' | |
168 | can be used to verify the existence of the default configuration file. | |
169 | ||
170 | By using \'\-\' for FILE, the configuration is read from standard | |
171 | input. This is useful for commands like: | |
172 | .nf | |
173 | .B echo /dev/hdb \-m user@home \-M test | smartd \-c \- \-q onecheck | |
174 | .fi | |
175 | to perform quick and simple checks without a configuration file. | |
176 | ||
a23d5117 GI |
177 | .\" BEGIN ENABLE_CAPABILITIES |
178 | .TP | |
179 | .B \-C, \-\-capabilities | |
180 | Use \fBcapabilities(7)\fP (EXPERIMENTAL). | |
181 | ||
182 | Warning: Mail notification does not work when used. | |
183 | ||
184 | .\" END ENABLE_CAPABILITIES | |
832b75ed GG |
185 | .TP |
186 | .B \-d, \-\-debug | |
187 | Runs \fBsmartd\fP in "debug" mode. In this mode, it displays status | |
188 | information to STDOUT rather than logging it to SYSLOG and does not | |
189 | \fBfork(2)\fP into the background and detach from the controlling | |
190 | terminal. In this mode, \fBsmartd\fP also prints more verbose | |
191 | information about what it is doing than when operating in "daemon" | |
192 | mode. In this mode, the \fBQUIT\fP signal (normally generated from a | |
193 | terminal with CONTROL\-C) makes \fBsmartd\fP reload its configuration | |
194 | file. Please use CONTROL-\e to exit | |
195 | (Cygwin: 2x CONTROL\-C, Windows: CONTROL\-Break). | |
196 | ||
197 | Windows only: The "debug" mode can be toggled by the command | |
198 | \fBsmartd sigusr2\fP. A new console for debug output is opened when | |
199 | debug mode is enabled. | |
200 | .TP | |
201 | .B \-D, \-\-showdirectives | |
202 | Prints a list (to STDOUT) of all the possible Directives which may | |
203 | appear in the configuration file /usr/local/etc/smartd.conf, and then exits. | |
204 | These Directives are also described later in this man page. They may | |
205 | appear in the configuration file following the device name. | |
206 | .TP | |
207 | .B \-h, \-\-help, \-\-usage | |
208 | Prints usage message to STDOUT and exits. | |
2127e193 | 209 | |
832b75ed GG |
210 | .TP |
211 | .B \-i N, \-\-interval=N | |
212 | Sets the interval between disk checks to \fIN\fP seconds, where | |
213 | \fIN\fP is a decimal integer. The minimum allowed value is ten and | |
214 | the maximum is the largest positive integer that can be represented on | |
215 | your system (often 2^31-1). The default is 1800 seconds. | |
216 | ||
217 | Note that the superuser can make \fBsmartd\fP check the status of the | |
218 | disks at any time by sending it the \fBSIGUSR1\fP signal, for example | |
219 | with the command: | |
220 | .nf | |
221 | .B kill -SIGUSR1 <pid> | |
222 | .fi | |
223 | where \fB<pid>\fP is the process id number of \fBsmartd\fP. One may | |
224 | also use: | |
225 | .nf | |
226 | .B killall -USR1 smartd | |
227 | .fi | |
228 | for the same purpose. | |
229 | .fi | |
230 | (Windows: See NOTES below.) | |
231 | ||
232 | .TP | |
233 | .B \-l FACILITY, \-\-logfacility=FACILITY | |
234 | Uses syslog facility FACILITY to log the messages from \fBsmartd\fP. | |
235 | Here FACILITY is one of \fIlocal0\fP, \fIlocal1\fP, ..., \fIlocal7\fP, | |
236 | or \fIdaemon\fP [default]. If this command-line option is not used, | |
237 | then by default messages from \fBsmartd\fP are logged to the facility | |
238 | \fIdaemon\fP. | |
239 | ||
240 | If you would like to have \fBsmartd\fP messages logged somewhere other | |
241 | than the default \fB/var/log/messages\fP location, this can typically | |
242 | be accomplished with (for example) the following steps: | |
243 | .RS 7 | |
244 | .IP \fB[1]\fP 4 | |
245 | Modify the script that starts \fBsmartd\fP to include the \fBsmartd\fP | |
246 | command-line argument \'\-l local3\'. This tells \fBsmartd\fP to log its | |
247 | messages to facility \fBlocal3\fP. | |
248 | .IP \fB[2]\fP 4 | |
249 | Modify the \fBsyslogd\fP configuration file (typically | |
250 | \fB/etc/syslog.conf\fP) by adding a line of the form: | |
251 | .nf | |
252 | \fBlocal3.* /var/log/smartd.log\fP | |
253 | .fi | |
254 | This tells \fBsyslogd\fP to log all the messages from facility \fBlocal3\fP to | |
255 | the designated file: /var/log/smartd.log. | |
256 | .IP \fB[3]\fP 4 | |
257 | Tell \fBsyslogd\fP to re-read its configuration file, typically by | |
258 | sending the \fBsyslogd\fP process a \fBSIGHUP\fP hang-up signal. | |
259 | .IP \fB[4]\fP 4 | |
260 | Start (or restart) the \fBsmartd\fP daemon. | |
261 | .RE | |
262 | .\" The following two lines are a workaround for a man2html bug. Please leave them. | |
263 | .\" They define a non-existent option; useful because man2html can't correctly reset the margins. | |
264 | .TP | |
265 | .B \& | |
266 | For more detailed information, please refer to the man pages for | |
267 | \fBsyslog.conf\fP, \fBsyslogd\fP, and \fBsyslog\fP. You may also want | |
268 | to modify the log rotation configuration files; see the man pages for | |
269 | \fBlogrotate\fP and examine your system\'s /etc/logrotate.conf file. | |
270 | ||
271 | Cygwin: Support for \fBsyslogd\fP as described above is available starting with Cygwin 1.5.15. | |
272 | On older releases or if no local \fBsyslogd\fP is running, the \'\-l\' option has no effect. | |
273 | In this case, all \fBsyslog\fP messages are written to Windows event log | |
274 | or to file \fBC:/CYGWIN_SYSLOG.TXT\fP if the event log is not available. | |
275 | ||
276 | Windows: Some \fBsyslog\fP functionality is implemented | |
277 | internally in \fBsmartd\fP as follows: If no \'\-l\' option | |
278 | (or \'\-l daemon\') is specified, messages are written to Windows | |
279 | event log or to file \fB./smartd.log\fP if event log is not available | |
280 | (Win9x/ME or access denied). By specifying other values of FACILITY, | |
281 | log output is redirected as follows: | |
282 | \'\-l local0\' to file \fB./smartd.log\fP, | |
283 | \'\-l local1\' to standard output (redirect with \'>\' to any file), | |
284 | \'\-l local2\' to standard error, | |
285 | \'\-l local[3-7]\': to file \fB./smartd[1-5].log\fP. | |
286 | ||
287 | When using the event log, the enclosed utility \fBsyslogevt.exe\fP | |
288 | should be registered as an event message file to avoid error | |
289 | messages from the event viewer. Use \'\fBsyslogevt -r smartd\fP\' | |
290 | to register, \'\fBsyslogevt -u smartd\fP\' to unregister and | |
291 | \'\fBsyslogevt\fP\' for more help. | |
292 | ||
a37e7145 GG |
293 | .TP |
294 | .B \-n, \-\-no\-fork | |
295 | Do not fork into background; this is useful when executed from modern | |
296 | init methods like initng, minit or supervise. | |
297 | ||
298 | On Cygwin, this allows running \fBsmartd\fP as service via cygrunsrv, | |
299 | see NOTES below. | |
300 | ||
301 | On Windows, this option is not available, use \'\-\-service\' instead. | |
302 | ||
832b75ed GG |
303 | .TP |
304 | .B \-p NAME, \-\-pidfile=NAME | |
305 | Writes pidfile \fINAME\fP containing the \fBsmartd\fP Process ID | |
306 | number (PID). To avoid symlink attacks make sure the directory to | |
307 | which pidfile is written is only writable for root. Without this | |
308 | option, or if the \-\-debug option is given, no PID file is written on | |
309 | startup. If \fBsmartd\fP is killed with a maskable signal then the | |
310 | pidfile is removed. | |
311 | .TP | |
312 | .B \-q WHEN, \-\-quit=WHEN | |
313 | Specifies when, if ever, \fBsmartd\fP should exit. The valid | |
314 | arguments are to this option are: | |
315 | ||
316 | .I nodev | |
317 | \- Exit if there are no devices to monitor, or if any errors are found | |
318 | at startup in the configuration file. This is the default. | |
319 | ||
320 | .I errors | |
321 | \- Exit if there are no devices to monitor, or if any errors are found | |
322 | in the configuration file /usr/local/etc/smartd.conf at startup or whenever it | |
323 | is reloaded. | |
324 | ||
325 | .I nodevstartup | |
326 | \- Exit if there are no devices to monitor at startup. But continue | |
327 | to run if no devices are found whenever the configuration file is | |
328 | reloaded. | |
329 | ||
330 | .I never | |
331 | \- Only exit if a fatal error occurs (no remaining system memory, | |
332 | invalid command line arguments). In this mode, even if there are no | |
333 | devices to monitor, or if the configuration file | |
334 | \fB/usr/local/etc/smartd.conf\fP has errors, \fBsmartd\fP will continue to run, | |
335 | waiting to load a configuration file listing valid devices. | |
336 | ||
337 | .I onecheck | |
338 | \- Start \fBsmartd\fP in debug mode, then register devices, then check | |
339 | device\'s SMART status once, and then exit with zero exit status if all | |
340 | of these steps worked correctly. | |
341 | ||
342 | This last option is intended for \'distribution-writers\' who want to | |
343 | create automated scripts to determine whether or not to automatically | |
344 | start up \fBsmartd\fP after installing smartmontools. After starting | |
345 | \fBsmartd\fP with this command-line option, the distribution\'s install | |
346 | scripts should wait a reasonable length of time (say ten seconds). If | |
347 | \fBsmartd\fP has not exited with zero status by that time, the script | |
348 | should send \fBsmartd\fP a SIGTERM or SIGKILL and assume that | |
349 | \fBsmartd\fP will not operate correctly on the host. Conversely, if | |
350 | \fBsmartd\fP exits with zero status, then it is safe to run | |
351 | \fBsmartd\fP in normal daemon mode. If \fBsmartd\fP is unable to | |
352 | monitor any devices or encounters other problems then it will return | |
353 | with non-zero exit status. | |
354 | ||
355 | .I showtests | |
356 | \- Start \fBsmartd\fP in debug mode, then register devices, then write | |
357 | a list of future scheduled self tests to stdout, and then exit with zero | |
358 | exit status if all of these steps worked correctly. | |
359 | Device's SMART status is not checked. | |
360 | ||
361 | This option is intended to test whether the '-s REGEX' directives in | |
362 | smartd.conf will have the desired effect. The output lists the next test | |
363 | schedules, limited to 5 tests per type and device. This is followed by a | |
364 | summary of all tests of each device within the next 90 days. | |
365 | .TP | |
366 | .B \-r TYPE, \-\-report=TYPE | |
367 | Intended primarily to help | |
368 | .B smartmontools | |
369 | developers understand the behavior of | |
370 | .B smartmontools | |
371 | on non-conforming or poorly-conforming hardware. This option reports | |
372 | details of | |
373 | \fBsmartd\fP | |
374 | transactions with the device. The option can be used multiple times. | |
375 | When used just once, it shows a record of the ioctl() transactions | |
376 | with the device. When used more than once, the detail of these ioctl() | |
377 | transactions are reported in greater detail. The valid arguments to | |
378 | this option are: | |
379 | ||
380 | .I ioctl | |
381 | \- report all ioctl() transactions. | |
382 | ||
383 | .I ataioctl | |
384 | \- report only ioctl() transactions with ATA devices. | |
385 | ||
386 | .I scsiioctl | |
387 | \- report only ioctl() transactions with SCSI devices. | |
388 | ||
389 | Any argument may include a positive integer to specify the level of | |
390 | detail that should be reported. The argument should be followed by a | |
391 | comma then the integer with no spaces. For example, \fIataioctl,2\fP | |
392 | The default level is 1, so \'\-r ataioctl,1\' and \'\-r ataioctl\' are | |
393 | equivalent. | |
394 | ||
2127e193 GI |
395 | .TP |
396 | .B \-s PREFIX, \-\-savestates=PREFIX | |
397 | [NEW EXPERIMENTAL SMARTD FEATURE] [ATA ONLY] | |
398 | Reads/writes \fBsmartd\fP state information from/to files | |
399 | \'PREFIX\'\'MODEL\-SERIAL.ata.state\'. This preserves SMART attributes, drive | |
400 | min and max temperatures (\-W directive), info about last sent warning email | |
401 | (\-m directive), and the time of next check of the self-test REGEXP | |
402 | (\-s directive) across boot cycles. | |
403 | ||
404 | .\" BEGIN ENABLE_SAVESTATES | |
405 | If this option is not specified, state information is maintained in files | |
406 | \'/usr/local/var/lib/smartmontools/smartd.MODEL\-SERIAL.ata.state\'. | |
407 | To disable state files, specify this option with an empty string | |
408 | argument: \'-s ""\'. | |
409 | .\" END ENABLE_SAVESTATES | |
410 | MODEL and SERIAL are build from drive identify information, invalid | |
411 | characters are replaced by underline. | |
412 | ||
413 | If the PREFIX has the form \'/path/dir/\' (e.g. \'/var/lib/smartd/\'), then | |
414 | files \'MODEL\-SERIAL.ata.state\' are created in directory \'/path/dir\'. | |
415 | If the PREFIX has the form \'/path/name\' (e.g. \'/var/lib/misc/smartd\-\'), | |
416 | then files 'nameMODEL\-SERIAL.ata.state' are created in directory '/path/'. | |
417 | The path must be absolute, except if debug mode is enabled. | |
418 | ||
419 | The state information files are read on smartd startup. The files are | |
420 | always (re)written after reading the configuration file, before rereading | |
421 | the configuration file (SIGHUP), before smartd shutdown, and after a check | |
422 | forced by SIGUSR1. After a normal check cycle, a file is only rewritten if | |
423 | an important change (which usually results in a SYSLOG output) occurred. | |
424 | ||
832b75ed GG |
425 | .TP |
426 | .B \-\-service | |
427 | Cygwin and Windows only: Enables \fBsmartd\fP to run as a Windows service. | |
428 | ||
a37e7145 GG |
429 | On Cygwin, this option is kept for backward compatibility only. |
430 | It has the same effect as \'\-n, \-\-no\-fork\', see above. | |
832b75ed GG |
431 | |
432 | On Windows, this option enables the buildin service support. | |
433 | The option must be specified in the service command line as the first | |
434 | argument. It should not be used from console. | |
435 | See NOTES below for details. | |
436 | ||
437 | .TP | |
438 | .B \-V, \-\-version, \-\-license, \-\-copyright | |
2127e193 GI |
439 | Prints version, copyright, license, home page and SVN revision |
440 | information for your copy of \fBsmartd\fP to STDOUT and then exits. | |
441 | Please include this information if you are reporting bugs or problems. | |
832b75ed GG |
442 | |
443 | .SH EXAMPLES | |
444 | ||
445 | .B | |
446 | smartd | |
447 | .fi | |
448 | Runs the daemon in forked mode. This is the normal way to run | |
449 | \fBsmartd\fP. | |
450 | Entries are logged to SYSLOG (by default | |
451 | .B /var/log/messages.) | |
452 | ||
453 | .B | |
454 | smartd -d -i 30 | |
455 | .fi | |
456 | Run in foreground (debug) mode, checking the disk status | |
457 | every 30 seconds. | |
458 | ||
459 | .B | |
460 | smartd -q onecheck | |
461 | .fi | |
462 | Registers devices, and checks the status of the devices exactly | |
463 | once. The exit status (the bash | |
464 | .B $? | |
465 | variable) will be zero if all went well, and nonzero if no devices | |
466 | were detected or some other problem was encountered. | |
467 | ||
468 | .fi | |
469 | Note that \fBsmartmontools\fP provides a start-up script in | |
470 | \fB/usr/local/etc/rc.d/init.d/smartd\fP which is responsible for starting and | |
471 | stopping the daemon via the normal init interface. Using this script, | |
472 | you can start \fBsmartd\fP by giving the command: | |
473 | .nf | |
474 | .B /usr/local/etc/rc.d/init.d/smartd start | |
475 | .fi | |
476 | and stop it by using the command: | |
477 | .nf | |
478 | .B /usr/local/etc/rc.d/init.d/smartd stop | |
479 | ||
480 | .fi | |
481 | If you want \fBsmartd\fP to start running whenever your machine is | |
482 | booted, this can be enabled by using the command: | |
483 | .nf | |
484 | .B /sbin/chkconfig --add smartd | |
485 | .fi | |
486 | and disabled using the command: | |
487 | .nf | |
488 | .B /sbin/chkconfig --del smartd | |
489 | .fi | |
490 | ||
491 | .\" DO NOT MODIFY THIS OR THE FOLLOWING TWO LINES. THIS MATERIAL | |
492 | .\" IS AUTOMATICALLY INCLUDED IN THE FILE smartd.conf.5 | |
493 | .\" STARTINCLUDE | |
494 | ||
495 | .SH CONFIGURATION FILE /usr/local/etc/smartd.conf | |
496 | In the absence of a configuration file, under Linux | |
497 | \fBsmartd\fP | |
498 | will try to open the 20 ATA devices | |
499 | .B /dev/hd[a-t] | |
500 | and the 26 SCSI devices | |
501 | .B /dev/sd[a-z]. | |
502 | Under FreeBSD, | |
503 | \fBsmartd\fP | |
504 | will try to open all existing ATA devices (with entries in /dev) | |
505 | .B /dev/ad[0-9]+ | |
eb07ddf2 | 506 | and all existing SCSI devices (using CAM subsystem). |
832b75ed GG |
507 | Under NetBSD/OpenBSD, |
508 | \fBsmartd\fP | |
509 | will try to open all existing ATA devices (with entries in /dev) | |
510 | .B /dev/wd[0-9]+c | |
511 | and all existing SCSI devices | |
512 | .B /dev/sd[0-9]+c. | |
513 | Under Solaris \fBsmartd\fP will try to open all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk | |
514 | devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices. | |
515 | Under Windows \fBsmartd\fP will try to open all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]") | |
516 | for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP | |
517 | (bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME, | |
518 | and \fB"/dev/scsi[0-9][0-7]"\fP (ASPI adapter 0-9, ID 0-7) for SCSI | |
519 | devices on all versions of Windows. | |
520 | Under Darwin, \fBsmartd\fP will open any ATA block storage device. | |
521 | ||
522 | This can be annoying if you have an ATA or SCSI device that hangs or | |
523 | misbehaves when receiving SMART commands. Even if this causes no | |
524 | problems, you may be annoyed by the string of error log messages about | |
525 | block-major devices that can\'t be found, and SCSI devices that can\'t | |
526 | be opened. | |
527 | ||
528 | One can avoid this problem, and gain more control over the types of | |
529 | events monitored by | |
530 | \fBsmartd\fP, | |
531 | by using the configuration file | |
532 | .B /usr/local/etc/smartd.conf. | |
533 | This file contains a list of devices to monitor, with one device per | |
534 | line. An example file is included with the | |
535 | .B smartmontools | |
536 | distribution. You will find this sample configuration file in | |
537 | \fB/usr/local/share/doc/smartmontools-5.1/\fP. For security, the configuration file | |
538 | should not be writable by anyone but root. The syntax of the file is as | |
539 | follows: | |
540 | .IP \(bu 4 | |
541 | There should be one device listed per line, although you may have | |
542 | lines that are entirely comments or white space. | |
543 | .IP \(bu 4 | |
544 | Any text following a hash sign \'#\' and up to the end of the line is | |
545 | taken to be a comment, and ignored. | |
546 | .IP \(bu 4 | |
547 | Lines may be continued by using a backslash \'\e\' as the last | |
548 | non-whitespace or non-comment item on a line. | |
549 | .IP \(bu 4 | |
550 | Note: a line whose first character is a hash sign \'#\' is treated as | |
551 | a white-space blank line, \fBnot\fP as a non-existent line, and will | |
552 | \fBend\fP a continuation line. | |
553 | .PP 0 | |
554 | .fi | |
555 | Here is an example configuration file. It\'s for illustrative purposes | |
556 | only; please don\'t copy it onto your system without reading to the end | |
557 | of the | |
558 | .B DIRECTIVES | |
559 | Section below! | |
560 | ||
561 | .nf | |
562 | .B ################################################ | |
563 | .B # This is an example smartd startup config file | |
564 | .B # /usr/local/etc/smartd.conf for monitoring three | |
565 | .B # ATA disks, three SCSI disks, six ATA disks | |
4d59bff9 | 566 | .B # behind two 3ware controllers, three SATA disks |
2127e193 GI |
567 | .B # directly connected to the HighPoint Rocket- |
568 | .B # RAID controller, two SATA disks connected to | |
569 | .B # the HighPoint RocketRAID controller via a pmport | |
570 | .B # device, four SATA disks connected to an Areca | |
571 | .B # RAID controller, and one SATA disk. | |
832b75ed GG |
572 | .B # |
573 | .nf | |
574 | .B # First ATA disk on two different interfaces. On | |
575 | .B # the second disk, start a long self-test every | |
576 | .B # Sunday between 3 and 4 am. | |
577 | .B # | |
578 | .B \ \ /dev/hda -a -m admin@example.com,root@localhost | |
579 | .B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03 | |
580 | .B # | |
581 | .nf | |
582 | .B # SCSI disks. Send a TEST warning email to admin on | |
583 | .B # startup. | |
584 | .B # | |
585 | .B \ \ /dev/sda | |
586 | .B \ \ /dev/sdb -m admin@example.com -M test | |
587 | .B # | |
588 | .nf | |
589 | .B # Strange device. It\'s SCSI. Start a scheduled | |
590 | .B # long self test between 5 and 6 am Monday/Thursday | |
591 | .B \ \ /dev/weird -d scsi -s L/../../(1|4)/05 | |
592 | .B # | |
593 | .nf | |
9ebc753d GG |
594 | .B # An ATA disk may appear as a SCSI device to the |
595 | .B # OS. If a SCSI to ATA Translation (SAT) layer | |
596 | .B # is between the OS and the device then this can be | |
597 | .B # flagged with the '-d sat' option. This situation | |
598 | .B # may become common with SATA disks in SAS and FC | |
599 | .B # environments. | |
600 | .B \ \ /dev/sda -a -d sat | |
832b75ed GG |
601 | .B # |
602 | .nf | |
2127e193 GI |
603 | .B # Three disks connected to a MegaRAID controller |
604 | .B # Start short self-tests daily between 1-2, 2-3, and | |
605 | .B # 3-4 am. | |
606 | .B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01 | |
607 | .B \ \ /dev/sda -d megaraid,1 -a -s S/../.././02 | |
608 | .B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03 | |
609 | .B | |
610 | .B # | |
611 | .nf | |
832b75ed GG |
612 | .B # Four ATA disks on a 3ware 6/7/8000 controller. |
613 | .B # Start short self-tests daily between midnight and 1am, | |
614 | .B # 1-2, 2-3, and 3-4 am. Starting with the Linux 2.6 | |
615 | .B # kernel series, /dev/sdX is deprecated in favor of | |
616 | .B # /dev/tweN. For example replace /dev/sdc by /dev/twe0 | |
617 | .B # and /dev/sdd by /dev/twe1. | |
618 | .B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00 | |
619 | .B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01 | |
620 | .B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02 | |
621 | .B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03 | |
622 | .B # | |
623 | .nf | |
624 | .B # Two ATA disks on a 3ware 9000 controller. | |
625 | .B # Start long self-tests Sundays between midnight and | |
626 | .B # 1am and 2-3 am | |
627 | .B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00 | |
628 | .B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02 | |
629 | .B # | |
630 | .nf | |
2127e193 | 631 | .B # Three SATA disks on a HighPoint RocketRAID controller. |
4d59bff9 GG |
632 | .B # Start short self-tests daily between 1-2, 2-3, and |
633 | .B # 3-4 am. | |
2127e193 | 634 | .B # under Linux |
4d59bff9 GG |
635 | .B \ \ /dev/sde -d hpt,1/1 -a -s S/../.././01 |
636 | .B \ \ /dev/sde -d hpt,1/2 -a -s S/../.././02 | |
637 | .B \ \ /dev/sde -d hpt,1/3 -a -s S/../.././03 | |
2127e193 GI |
638 | .B # or under FreeBSD |
639 | .B # /dev/hptrr -d hpt,1/1 -a -s S/../.././01 | |
640 | .B # /dev/hptrr -d hpt,1/2 -a -s S/../.././02 | |
641 | .B # /dev/hptrr -d hpt,1/3 -a -s S/../.././03 | |
4d59bff9 GG |
642 | .B # |
643 | .nf | |
2127e193 | 644 | .B # Two SATA disks connected to a HighPoint RocketRAID |
4d59bff9 | 645 | .B # via a pmport device. Start long self-tests Sundays |
9ebc753d | 646 | .B # between midnight and 1am and 2-3 am. |
2127e193 | 647 | .B # under Linux |
4d59bff9 GG |
648 | .B \ \ /dev/sde -d hpt,1/4/1 -a -s L/../../7/00 |
649 | .B \ \ /dev/sde -d hpt,1/4/2 -a -s L/../../7/02 | |
2127e193 GI |
650 | .B # or under FreeBSD |
651 | .B # /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00 | |
652 | .B # /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02 | |
653 | .B # | |
654 | .nf | |
655 | .B # Three SATA disks connected to an Areca | |
656 | .B # RAID controller. Start long self-tests Sundays | |
657 | .B # between midnight and 3 am. | |
658 | .B \ \ /dev/sg2 -d areca,1 -a -s L/../../7/00 | |
659 | .B \ \ /dev/sg2 -d areca,2 -a -s L/../../7/01 | |
660 | .B \ \ /dev/sg2 -d areca,3 -a -s L/../../7/02 | |
4d59bff9 GG |
661 | .B # |
662 | .nf | |
832b75ed GG |
663 | .B # The following line enables monitoring of the |
664 | .B # ATA Error Log and the Self-Test Error Log. | |
665 | .B # It also tracks changes in both Prefailure | |
666 | .B # and Usage Attributes, apart from Attributes | |
667 | .B # 9, 194, and 231, and shows continued lines: | |
668 | .B # | |
669 | .B \ \ /dev/hdd\ -l\ error\ \e | |
670 | .B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e | |
671 | .B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked: | |
672 | .B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature | |
673 | .B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature | |
674 | .B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours | |
675 | .B # | |
676 | .B ################################################ | |
677 | .fi | |
678 | ||
679 | .PP | |
680 | .SH CONFIGURATION FILE DIRECTIVES | |
681 | .PP | |
682 | ||
683 | If the first non-comment entry in the configuration file is the text | |
684 | string | |
685 | .B DEVICESCAN | |
686 | in capital letters, then | |
687 | \fBsmartd\fP | |
688 | will ignore any remaining lines in the configuration file, and will | |
689 | scan for devices. | |
690 | .B DEVICESCAN | |
691 | may optionally be followed by Directives that will apply to all | |
692 | devices that are found in the scan. Please see below for additional | |
693 | details. | |
694 | ||
695 | .sp 2 | |
696 | The following are the Directives that may appear following the device | |
697 | name or | |
698 | .B DEVICESCAN | |
699 | on any line of the | |
700 | .B /usr/local/etc/smartd.conf | |
701 | configuration file. Note that | |
702 | .B these are NOT command-line options for | |
703 | \fBsmartd\fP. | |
704 | The Directives below may appear in any order, following the device | |
705 | name. | |
706 | ||
707 | .B For an ATA device, | |
708 | if no Directives appear, then the device will be monitored | |
709 | as if the \'\-a\' Directive (monitor all SMART properties) had been given. | |
710 | ||
711 | .B If a SCSI disk is listed, | |
712 | it will be monitored at the maximum implemented level: roughly | |
713 | equivalent to using the \'\-H \-l selftest\' options for an ATA disk. | |
714 | So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and | |
715 | \'\-M\', the Directives below are ignored for SCSI disks. For SCSI | |
716 | disks, the \'\-m\' Directive sends a warning email if the SMART status | |
717 | indicates a disk failure or problem, if the SCSI inquiry about disk | |
718 | status fails, or if new errors appear in the self-test log. | |
719 | ||
720 | .B If a 3ware controller is used | |
721 | then the corresponding SCSI (/dev/sd?) or character device (/dev/twe? | |
722 | or /dev/twa?) must be listed, along with the \'\-d 3ware,N\' Directive | |
723 | (see below). The individual ATA disks hosted by the 3ware controller | |
724 | appear to \fBsmartd\fP as normal ATA devices. Hence all the ATA | |
725 | directives can be used for these disks (but see note below). | |
726 | ||
2127e193 GI |
727 | .B If an Areca controller is used |
728 | then the corresponding SCSI generic device (/dev/sg?) must be listed, | |
729 | along with the \'\-d areca,N\' Directive (see below). The individual | |
730 | SATA disks hosted by the Areca controller appear to \fBsmartd\fP as | |
731 | normal ATA devices. Hence all the ATA directives can be used for | |
732 | these disks. Areca firmware version 1.46 or later which supports | |
bed94269 GI |
733 | smartmontools must be used; Please see the \fBsmartctl\fP(8) man page |
734 | for further details. | |
2127e193 | 735 | |
832b75ed GG |
736 | .TP |
737 | .B \-d TYPE | |
738 | Specifies the type of the device. This Directive may be used multiple | |
2127e193 GI |
739 | times for one device, but the arguments \fIata\fP, \fIscsi\fP, |
740 | \fIsat\fP, \fImarvell\fP, \fIcciss,N\fP, \fIareca,N\fP, \fImegaraid,N\fP | |
741 | and \fI3ware,N\fP are mutually-exclusive. If more than one is given then | |
742 | \fBsmartd\fP will use the last one which appears. | |
832b75ed GG |
743 | |
744 | If none of these three arguments is given, then \fBsmartd\fP will | |
745 | first attempt to guess the device type by looking at whether the sixth | |
746 | character in the device name is an \'s\' or an \'h\'. This will work for | |
747 | device names like /dev/hda or /dev/sdb, and corresponds to choosing | |
748 | \fIata\fP or \fIscsi\fP respectively. If | |
749 | \fBsmartd\fP | |
750 | can\'t guess from this sixth character, then it will simply try to | |
751 | access the device using first ATA and then SCSI ioctl()s. | |
752 | ||
753 | The valid arguments to this Directive are: | |
754 | ||
755 | .I ata | |
756 | \- the device type is ATA. This prevents | |
757 | \fBsmartd\fP | |
758 | from issuing SCSI commands to an ATA device. | |
759 | ||
760 | .I scsi | |
761 | \- the device type is SCSI. This prevents | |
762 | \fBsmartd\fP | |
763 | from issuing ATA commands to a SCSI device. | |
764 | ||
4d59bff9 GG |
765 | .I sat |
766 | \- the device type is SCSI to ATA Translation (SAT). | |
767 | \fBsmartd\fP | |
768 | will generate ATA (smart) commands and then package them in | |
769 | the SAT defined ATA PASS THROUGH SCSI commands. The commands | |
770 | are then routed through the SCSI pass through interface to the | |
771 | operating system. There are two types of ATA PASS THROUGH | |
772 | SCSI commands: a 12 byte and 16 byte variant. | |
773 | \fBsmartd\fP | |
774 | can use either and defaults to the 16 byte variant. This can | |
775 | be overridden with this syntax: \'\-d sat,12\' or \'\-d sat,16\'. | |
776 | ||
832b75ed GG |
777 | .I marvell |
778 | \- Under Linux, interact with SATA disks behind Marvell chip-set | |
779 | controllers (using the Marvell rather than libata driver). | |
780 | ||
2127e193 GI |
781 | .I megaraid,N |
782 | \- the device consists of one or more SCSI/SAS/SATA disks connected | |
783 | to a MegaRAID controller. The non-negative integer N (in the range | |
784 | of 0 to 127 inclusive) denotes which disk on the controller is monitored. | |
785 | In log files and email messages this disk will be identified as | |
786 | megaraid_disk_XXX with XXX in the range from 000 to 127 inclusive. | |
787 | ||
832b75ed GG |
788 | .I 3ware,N |
789 | \- the device consists of one or more ATA disks connected to a 3ware | |
2127e193 | 790 | RAID controller. The non-negative integer N (in the range from 0 to 127 |
832b75ed | 791 | inclusive) denotes which disk on the controller is monitored. In log |
2127e193 GI |
792 | files and email messages this disk will be identified as 3ware_disk_XXX |
793 | with XXX in the range from 000 to 127 inclusive. | |
832b75ed GG |
794 | |
795 | This Directive may at first appear confusing, because the 3ware | |
796 | controller is a SCSI device (such as /dev/sda) and should be listed as | |
797 | such in the the configuration file. | |
798 | However when the \'\-d 3ware,N\' | |
799 | Directive is used, then the corresponding disk is addressed using | |
800 | native ATA commands which are \'passed through\' the SCSI driver. All | |
801 | ATA Directives listed in this man page may be used. Note that while | |
802 | you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to | |
803 | address \fBany\fP of the physical disks (3ware ports), error and log | |
804 | messages will make the most sense if you always list the 3ware SCSI | |
805 | logical device corresponding to the particular physical disks. Please | |
bed94269 | 806 | see the \fBsmartctl\fP(8) man page for further details. |
832b75ed GG |
807 | |
808 | ATA disks behind 3ware controllers may alternatively be accessed via a | |
809 | character device interface /dev/twe0-15 (3ware 6000/7000/8000 | |
810 | controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note | |
811 | that the 9000 series controllers may \fBonly\fP be accessed using the | |
812 | character device interface /dev/twa0-15 and not the SCSI device | |
bed94269 | 813 | interface /dev/sd?. Please see the \fBsmartctl\fP(8) man page for |
832b75ed GG |
814 | further details. |
815 | ||
816 | Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\' | |
817 | (\fB-S on\fP) and \'Enable Automatic Offline\' (\fB-o on\fP) commands | |
818 | to the disk, if the SCSI interface is used, and produce these types of | |
819 | harmless syslog error messages instead: \fB\'3w-xxxx: tw_ioctl(): | |
820 | Passthru size (123392) too big\'\fP. This can be fixed by upgrading to | |
821 | version 1.02.00.037 or later of the 3w-xxxx driver, or by applying a | |
822 | patch to older versions. See | |
823 | \fBhttp://smartmontools.sourceforge.net/\fP for instructions. | |
824 | Alternatively use the character device interfaces /dev/twe0-15 (3ware | |
825 | 6/7/8000 series controllers) or /dev/twa0-15 (3ware 9000 series | |
826 | controllers). | |
827 | ||
2127e193 GI |
828 | .I areca,N |
829 | \- the device consists of one or more SATA disks connected to an Areca | |
830 | SATA RAID controller. The positive integer N (in the range from 1 to | |
831 | 24 inclusive) denotes which disk on the controller is monitored. In | |
832 | log files and email messages this disk will be identifed as | |
833 | areca_disk_XX with XX in the range from 01 to 24 inclusive. | |
834 | ||
ba59cff1 GG |
835 | .I cciss,N |
836 | \- the device consists of one or more SCSI disks connected to a cciss | |
837 | RAID controller. The non-negative integer N (in the range from 0 to 15 | |
838 | inclusive) denotes which disk on the controller is monitored. In log | |
839 | files and email messages this disk will be identified as cciss_disk_XX | |
840 | with XX in the range from 00 to 15 inclusive. | |
832b75ed | 841 | |
2127e193 | 842 | .B 3ware, MegaRAID, Areca and cciss controllers are currently ONLY supported under Linux. |
832b75ed | 843 | |
4d59bff9 GG |
844 | .I hpt,L/M/N |
845 | \- the device consists of one or more ATA disks connected to a HighPoint | |
9ebc753d | 846 | RocketRAID controller. The integer L is the controller id, the integer M |
4d59bff9 GG |
847 | is the channel number, and the integer N is the PMPort number if it is |
848 | available. The allowed values of L are from 1 to 4 inclusive, M are from | |
849 | 1 to 8 inclusive and N from 1 to 4 if PMPort available. And also these | |
850 | values are limited by the model of the HighPoint RocketRAID controller. | |
851 | In log files and email messages this disk will be identified as | |
852 | hpt_X/X/X and X/X/X is the same as L/M/N, note if no N indicated, N set | |
853 | to the default value 1. | |
854 | ||
2127e193 | 855 | .B HighPoint RocketRAID controllers are currently ONLY supported under Linux and FreeBSD. |
4d59bff9 | 856 | |
832b75ed GG |
857 | .I removable |
858 | \- the device or its media is removable. This indicates to | |
859 | \fBsmartd\fP | |
860 | that it should continue (instead of exiting, which is the default | |
861 | behavior) if the device does not appear to be present when | |
862 | \fBsmartd\fP is started. This Directive may be used in conjunction | |
863 | with the other \'\-d\' Directives. | |
864 | ||
865 | .TP | |
2127e193 | 866 | .B \-n POWERMODE[,N][,q] |
832b75ed GG |
867 | This \'nocheck\' Directive is used to prevent a disk from being |
868 | spun-up when it is periodically polled by \fBsmartd\fP. | |
869 | ||
870 | ATA disks have five different power states. In order of increasing | |
871 | power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\', | |
872 | and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the | |
873 | disk\'s platters are not spinning. But usually, in response to SMART | |
874 | commands issued by \fBsmartd\fP, the disk platters are spun up. So if | |
875 | this option is not used, then a disk which is in a low\-power mode may | |
876 | be spun up and put into a higher\-power mode when it is periodically | |
877 | polled by \fBsmartd\fP. | |
878 | ||
879 | Note that if the disk is in SLEEP mode when \fBsmartd\fP is started, | |
880 | then it won't respond to \fBsmartd\fP commands, and so the disk won't | |
881 | be registered as a device for \fBsmartd\fP to monitor. If a disk is in | |
882 | any other low\-power mode, then the commands issued by \fBsmartd\fP to | |
883 | register the disk will probably cause it to spin\-up. | |
884 | ||
885 | The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s | |
886 | periodic checks should still be carried out when the device is in a | |
887 | low\-power mode. It may be used to prevent a disk from being spun\-up | |
888 | by periodic \fBsmartd\fP polling. The allowed values of POWERMODE | |
889 | are: | |
890 | ||
891 | .I never | |
892 | \- \fBsmartd\fP will poll (check) the device regardless of its power | |
893 | mode. This may cause a disk which is spun\-down to be spun\-up when | |
894 | \fBsmartd\fP checks it. This is the default behavior if the '\-n' | |
895 | Directive is not given. | |
896 | ||
897 | .I sleep | |
898 | \- check the device unless it is in SLEEP mode. | |
899 | ||
900 | .I standby | |
901 | \- check the device unless it is in SLEEP or STANDBY mode. In | |
902 | these modes most disks are not spinning, so if you want to prevent | |
903 | a laptop disk from spinning up each time that \fBsmartd\fP polls, | |
904 | this is probably what you want. | |
905 | ||
906 | .I idle | |
907 | \- check the device unless it is in SLEEP, STANDBY or IDLE mode. | |
908 | In the IDLE state, most disks are still spinning, so this is probably | |
909 | not what you want. | |
910 | ||
2127e193 GI |
911 | Maximum number of skipped checks (in a row) can be specified by |
912 | appending positive number \',N\' to POWERMODE (like \'\-n standby,15\'). | |
913 | After N checks are skipped in a row, powermode is ignored and the | |
914 | check is performed anyway. | |
4d59bff9 | 915 | |
832b75ed GG |
916 | When a periodic test is skipped, \fBsmartd\fP normally writes an |
917 | informal log message. The message can be suppressed by appending | |
918 | the option \',q\' to POWERMODE (like \'\-n standby,q\'). | |
919 | This prevents a laptop disk from spinning up due to this message. | |
920 | ||
2127e193 GI |
921 | Both \',N\' and \',q\' can be specified together. |
922 | ||
832b75ed GG |
923 | .TP |
924 | .B \-T TYPE | |
925 | Specifies how tolerant | |
926 | \fBsmartd\fP | |
927 | should be of SMART command failures. The valid arguments to this | |
928 | Directive are: | |
929 | ||
930 | .I normal | |
931 | \- do not try to monitor the disk if a mandatory SMART command fails, but | |
932 | continue if an optional SMART command fails. This is the default. | |
933 | ||
934 | .I permissive | |
935 | \- try to monitor the disk even if it appears to lack SMART | |
936 | capabilities. This may be required for some old disks (prior to | |
937 | ATA\-3 revision 4) that implemented SMART before the SMART standards | |
938 | were incorporated into the ATA/ATAPI Specifications. This may also be | |
939 | needed for some Maxtor disks which fail to comply with the ATA | |
940 | Specifications and don't properly indicate support for error\- or | |
941 | self\-test logging. | |
942 | ||
943 | [Please see the \fBsmartctl \-T\fP command-line option.] | |
944 | .TP | |
945 | .B \-o VALUE | |
946 | Enables or disables SMART Automatic Offline Testing when | |
947 | \fBsmartd\fP | |
948 | starts up and has no further effect. The valid arguments to this | |
949 | Directive are \fIon\fP and \fIoff\fP. | |
950 | ||
951 | The delay between tests is vendor-specific, but is typically four | |
952 | hours. | |
953 | ||
954 | Note that SMART Automatic Offline Testing is \fBnot\fP part of the ATA | |
955 | Specification. Please see the | |
956 | .B smartctl \-o | |
957 | command-line option documentation for further information about this | |
958 | feature. | |
959 | .TP | |
960 | .B \-S VALUE | |
961 | Enables or disables Attribute Autosave when \fBsmartd\fP | |
962 | starts up and has no further effect. The valid arguments to this | |
963 | Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices. | |
964 | [Please see the \fBsmartctl \-S\fP command-line option.] | |
965 | .TP | |
966 | .B \-H | |
967 | Check the SMART health status of the disk. If any Prefailure | |
968 | Attributes are less than or equal to their threshold values, then disk | |
969 | failure is predicted in less than 24 hours, and a message at loglevel | |
970 | .B \'LOG_CRITICAL\' | |
971 | will be logged to syslog. [Please see the | |
972 | .B smartctl \-H | |
973 | command-line option.] | |
974 | .TP | |
975 | .B \-l TYPE | |
976 | Reports increases in the number of errors in one of the two SMART logs. The | |
977 | valid arguments to this Directive are: | |
978 | ||
979 | .I error | |
980 | \- report if the number of ATA errors reported in the ATA Error Log | |
981 | has increased since the last check. | |
982 | ||
983 | .I selftest | |
984 | \- report if the number of failed tests reported in the SMART | |
985 | Self-Test Log has increased since the last check, or if the timestamp | |
986 | associated with the most recent failed test has increased. Note that | |
987 | such errors will \fBonly\fP be logged if you run self-tests on the | |
988 | disk (and it fails a test!). Self-Tests can be run automatically by | |
989 | \fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below. | |
990 | Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP | |
991 | and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of | |
992 | the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP | |
993 | command-line option.] | |
994 | ||
995 | [Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line | |
996 | options.] | |
997 | .TP | |
998 | .B \-s REGEXP | |
999 | Run Self-Tests or Offline Immediate Tests, at scheduled times. A | |
1000 | Self- or Offline Immediate Test will be run at the end of periodic | |
1001 | device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP | |
1002 | match the extended regular expression \fBREGEXP\fP. Here: | |
1003 | .RS 7 | |
1004 | .IP \fBT\fP 4 | |
1005 | is the type of the test. The values that \fBsmartd\fP will try to | |
1006 | match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a | |
1007 | \fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA | |
1008 | only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As | |
1009 | soon as a match is found, the test will be started and no additional | |
1010 | matches will be sought for that device and that polling cycle. | |
2127e193 GI |
1011 | |
1012 | [NEW EXPERIMENTAL SMARTD FEATURE] To run scheduled Selective | |
1013 | Self-Tests, use \'n\' for \fBn\fPext span, \'r\' to \fBr\fPedo last | |
1014 | span, or \'c\' to \fBc\fPontinue with next span or redo last span | |
1015 | based on status of last test. The LBA range is based on the first | |
1016 | span from the last test. | |
1017 | See the \fBsmartctl \-t select,[next|redo|cont]\fP options for | |
1018 | further info. | |
1019 | ||
832b75ed GG |
1020 | .IP \fBMM\fP 4 |
1021 | is the month of the year, expressed with two decimal digits. The | |
1022 | range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP | |
1023 | use a single decimal digit or the match will always fail! | |
1024 | .IP \fBDD\fP 4 | |
1025 | is the day of the month, expressed with two decimal digits. The | |
1026 | range is from 01 to 31 inclusive. Do \fBnot\fP | |
1027 | use a single decimal digit or the match will always fail! | |
1028 | .IP \fBd\fP 4 | |
1029 | is the day of the week, expressed with one decimal digit. The | |
1030 | range is from 1 (Monday) to 7 (Sunday) inclusive. | |
1031 | .IP \fBHH\fP 4 | |
1032 | is the hour of the day, written with two decimal digits, and given in | |
1033 | hours after midnight. The range is 00 (midnight to just before 1am) | |
1034 | to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a | |
1035 | single decimal digit or the match will always fail! | |
1036 | .RE | |
1037 | .\" The following two lines are a workaround for a man2html bug. Please leave them. | |
1038 | .\" They define a non-existent option; useful because man2html can't correctly reset the margins. | |
1039 | .TP | |
1040 | .B \& | |
1041 | Some examples follow. In reading these, keep in mind that in extended | |
1042 | regular expressions a dot \fB\'.\'\fP matches any single character, and | |
1043 | a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP, | |
1044 | \fBB\fP, or \fBC\fP. | |
1045 | ||
1046 | To schedule a short Self-Test between 2-3am every morning, use: | |
1047 | .nf | |
1048 | \fB \-s S/../.././02\fP | |
1049 | .fi | |
1050 | To schedule a long Self-Test between 4-5am every Sunday morning, use: | |
1051 | .nf | |
1052 | \fB \-s L/../../7/04\fP | |
1053 | .fi | |
1054 | To schedule a long Self-Test between 10-11pm on the first and | |
1055 | fifteenth day of each month, use: | |
1056 | .nf | |
1057 | \fB \-s L/../(01|15)/./22\fP | |
1058 | .fi | |
1059 | To schedule an Offline Immediate test after every midnight, 6am, | |
1060 | noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long | |
1061 | Self-Test every Saturday at 3-4am, use: | |
1062 | .nf | |
1063 | \fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP | |
1064 | .fi | |
2127e193 GI |
1065 | If Long Self-Tests of a large disks take longer than the system uptime, |
1066 | a full disk test can be performed by several Selective Self-Tests. | |
1067 | To setup a full test of a 1TB disk within 20 days (one 50GB span | |
1068 | each day), run this command once: | |
1069 | .nf | |
1070 | smartctl -t select,0-99999999 /dev/sda | |
1071 | .fi | |
1072 | To run the next test spans on Monday-Friday between 12-13am, run smartd | |
1073 | with this directive: | |
1074 | .nf | |
1075 | \fB \-s n/../../[1-5]/12\fP | |
1076 | .fi | |
1077 | ||
832b75ed GG |
1078 | |
1079 | Scheduled tests are run immediately following the regularly-scheduled | |
1080 | device polling, if the current local date, time, and test type, match | |
1081 | \fBREGEXP\fP. By default the regularly-scheduled device polling | |
1082 | occurs every thirty minutes after starting \fBsmartd\fP. Take caution | |
1083 | if you use the \'\-i\' option to make this polling interval more than | |
1084 | sixty minutes: the poll times may fail to coincide with any of the | |
2127e193 GI |
1085 | testing times that you have specified with \fBREGEXP\fP. In this case |
1086 | the test will be run following the next device polling. | |
832b75ed GG |
1087 | |
1088 | Before running an offline or self-test, \fBsmartd\fP checks to be sure | |
1089 | that a self-test is not already running. If a self-test \fBis\fP | |
1090 | already running, then this running self test will \fBnot\fP be | |
1091 | interrupted to begin another test. | |
1092 | ||
1093 | \fBsmartd\fP will not attempt to run \fBany\fP type of test if another | |
1094 | test was already started or run in the same hour. | |
1095 | ||
a37e7145 GG |
1096 | To avoid performance problems during system boot, \fBsmartd\fP will |
1097 | not attempt to run any scheduled tests following the very first | |
1098 | device polling (unless \'\-q onecheck\' is specified). | |
1099 | ||
832b75ed GG |
1100 | Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG. |
1101 | You can use these or the '-q showtests' command-line option to verify | |
1102 | that you constructed \fBREGEXP\fP correctly. The matching order | |
1103 | (\fBL\fP before \fBS\fP before \fBC\fP before \fBO\fP) ensures that | |
1104 | if multiple test types are all scheduled for the same hour, the | |
1105 | longer test type has precedence. This is usually the desired behavior. | |
1106 | ||
2127e193 GI |
1107 | If the scheduled tests are used in conjunction with state persistence |
1108 | (\'\-s\' option), smartd will also try to match the hours since last | |
1109 | shutdown (or 90 days at most). If any test would have been started | |
1110 | during downtime, the longest (see above) of these tests is run after | |
1111 | second device polling. | |
1112 | ||
1113 | If the \'\-n\' directive is used and any test would have been started | |
1114 | during disk standby time, the longest of these tests is run when the | |
1115 | disk is active again. | |
1116 | ||
832b75ed GG |
1117 | Unix users: please beware that the rules for extended regular |
1118 | expressions [regex(7)] are \fBnot\fP the same as the rules for | |
1119 | file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will | |
1120 | issue harmless informational warning messages if it detects characters | |
1121 | in \fBREGEXP\fP that appear to indicate that you have made this | |
1122 | mistake. | |
1123 | ||
1124 | .TP | |
1125 | .B \-m ADD | |
1126 | Send a warning email to the email address \fBADD\fP if the \'\-H\', | |
1127 | \'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a | |
1128 | new error, or if a SMART command to the disk fails. This Directive | |
1129 | only works in conjunction with these other Directives (or with the | |
1130 | equivalent default \'\-a\' Directive). | |
1131 | ||
1132 | To prevent your email in-box from getting filled up with warning | |
1133 | messages, by default only a single warning will be sent for each of | |
1134 | the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or | |
1135 | \'\-O\' even if more than one failure or error is detected or if the | |
1136 | failure or error persists. [This behavior can be modified; see the | |
1137 | \'\-M\' Directive below.] | |
1138 | ||
1139 | To send email to more than one user, please use the following "comma | |
1140 | separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP | |
1141 | (with no spaces). | |
1142 | ||
1143 | To test that email is being sent correctly, use the \'\-M test\' | |
1144 | Directive described below to send one test email message on | |
1145 | \fBsmartd\fP | |
1146 | startup. | |
1147 | ||
1148 | By default, email is sent using the system | |
1149 | .B mail | |
1150 | command. In order that | |
1151 | \fBsmartd\fP | |
1152 | find the mail command (normally /bin/mail) an executable named | |
1153 | .B \'mail\' | |
1154 | must be in the path of the shell or environment from which | |
1155 | \fBsmartd\fP | |
1156 | was started. If you wish to specify an explicit path to the mail | |
1157 | executable (for example /usr/local/bin/mail) or a custom script to | |
1158 | run, please use the \'\-M exec\' Directive below. | |
1159 | ||
1160 | Note that by default under Solaris, in the previous paragraph, | |
1161 | \'\fBmailx\fP\' and \'\fB/bin/mailx\fP\' are used, since Solaris | |
1162 | \'/bin/mail\' does not accept a \'\-s\' (Subject) command-line | |
1163 | argument. | |
1164 | ||
1165 | On Windows, the \'\fBBlat\fP\' mailer | |
1166 | (\fBhttp://blat.sourceforge.net/\fP) is used by default. | |
1167 | This mailer uses a different command line syntax, see | |
1168 | \'\-M exec\' below. | |
1169 | ||
1170 | Note also that there is a special argument | |
1171 | .B <nomailer> | |
1172 | which can be given to the \'\-m\' Directive in conjunction with the \'\-M | |
1173 | exec\' Directive. Please see below for an explanation of its effect. | |
1174 | ||
1175 | If the mailer or the shell running it produces any STDERR/STDOUT | |
1176 | output, then a snippet of that output will be copied to SYSLOG. The | |
1177 | remainder of the output is discarded. If problems are encountered in | |
1178 | sending mail, this should help you to understand and fix them. If | |
1179 | you have mail problems, we recommend running \fBsmartd\fP in debug | |
1180 | mode with the \'-d\' flag, using the \'-M test\' Directive described | |
1181 | below. | |
1182 | ||
1183 | The following extension is available on Windows: | |
1184 | By specifying \'\fBmsgbox\fP\' as a mail address, a warning | |
1185 | "email" is displayed as a message box on the screen. | |
1186 | Using both \'\fBmsgbox\fP\' and regular mail addresses is possible, | |
1187 | if \'\fBmsgbox\fP\' is the first word in the comma separated list. | |
1188 | With \'\fBsysmsgbox\fP\', a system modal (always on top) message box | |
1189 | is used. If running as a service, a service notification message box | |
1190 | (always shown on current visible desktop) is used. | |
1191 | ||
1192 | .TP | |
1193 | .B \-M TYPE | |
1194 | These Directives modify the behavior of the | |
1195 | \fBsmartd\fP | |
1196 | email warnings enabled with the \'\-m\' email Directive described above. | |
1197 | These \'\-M\' Directives only work in conjunction with the \'\-m\' | |
1198 | Directive and can not be used without it. | |
1199 | ||
1200 | Multiple \-M Directives may be given. If more than one of the | |
1201 | following three \-M Directives are given (example: \-M once \-M daily) | |
1202 | then the final one (in the example, \-M daily) is used. | |
1203 | ||
1204 | The valid arguments to the \-M Directive are (one of the following | |
1205 | three): | |
1206 | ||
1207 | .I once | |
1208 | \- send only one warning email for each type of disk problem detected. This | |
1209 | is the default. | |
1210 | ||
1211 | .I daily | |
1212 | \- send additional warning reminder emails, once per day, for each type | |
1213 | of disk problem detected. | |
1214 | ||
1215 | .I diminishing | |
1216 | \- send additional warning reminder emails, after a one-day interval, | |
1217 | then a two-day interval, then a four-day interval, and so on for each | |
1218 | type of disk problem detected. Each interval is twice as long as the | |
1219 | previous interval. | |
1220 | ||
1221 | In addition, one may add zero or more of the following Directives: | |
1222 | ||
1223 | .I test | |
1224 | \- send a single test email | |
1225 | immediately upon | |
1226 | \fBsmartd\fP | |
1227 | startup. This allows one to verify that email is delivered correctly. | |
9ebc753d GG |
1228 | Note that if this Directive is used, |
1229 | \fBsmartd\fP | |
1230 | will also send the normal email warnings that were enabled with the \'\-m\' Directive, | |
1231 | in addition to the single test email! | |
832b75ed GG |
1232 | |
1233 | .I exec PATH | |
1234 | \- run the executable PATH instead of the default mail command, when | |
1235 | \fBsmartd\fP | |
1236 | needs to send email. PATH must point to an executable binary file or | |
1237 | script. | |
1238 | ||
1239 | By setting PATH to point to a customized script, you can make | |
1240 | \fBsmartd\fP perform useful tricks when a disk problem is detected | |
1241 | (beeping the console, shutting down the machine, broadcasting warnings | |
1242 | to all logged-in users, etc.) But please be careful. \fBsmartd\fP | |
1243 | will \fBblock\fP until the executable PATH returns, so if your | |
1244 | executable hangs, then \fBsmartd\fP will also hang. Some sample | |
1245 | scripts are included in | |
1246 | /usr/local/share/doc/smartmontools-5.1/examplescripts/. | |
1247 | ||
1248 | The return status of the executable is recorded by \fBsmartd\fP in | |
1249 | SYSLOG. The executable is not expected to write to STDOUT or | |
1250 | STDERR. If it does, then this is interpreted as indicating that | |
1251 | something is going wrong with your executable, and a fragment of this | |
1252 | output is logged to SYSLOG to help you to understand the problem. | |
1253 | Normally, if you wish to leave some record behind, the executable | |
1254 | should send mail or write to a file or device. | |
1255 | ||
1256 | Before running the executable, \fBsmartd\fP sets a number of | |
1257 | environment variables. These environment variables may be used to | |
1258 | control the executable\'s behavior. The environment variables | |
1259 | exported by \fBsmartd\fP are: | |
1260 | .RS 7 | |
1261 | .IP \fBSMARTD_MAILER\fP 4 | |
1262 | is set to the argument of \-M exec, if present or else to \'mail\' | |
1263 | (examples: /bin/mail, mail). | |
1264 | .IP \fBSMARTD_DEVICE\fP 4 | |
1265 | is set to the device path (examples: /dev/hda, /dev/sdb). | |
1266 | .IP \fBSMARTD_DEVICETYPE\fP 4 | |
2127e193 GI |
1267 | is set to the device type (possible values: ata, scsi, 3ware,N, |
1268 | areca,N, hpt,L/M/N). Here N=0,...,127 denotes the ATA disk behind a | |
1269 | 3ware RAID controller and L/M/N denotes the SATA disk behind a | |
1270 | HighPoint RocketRAID controller. | |
832b75ed GG |
1271 | .IP \fBSMARTD_DEVICESTRING\fP 4 |
1272 | is set to the device description. For SMARTD_DEVICETYPE of ata or | |
1273 | scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers, | |
2127e193 GI |
1274 | the form used is \'/dev/sdc [3ware_disk_01]\'. For HighPoint |
1275 | RocketRAID controller, the form is \'/dev/sdd [hpt_1/1/1]\' under Linux | |
1276 | or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Areca controllers, the | |
1277 | form is \'/dev/sg2 [areca_disk_09]\'. In these cases the device string | |
1278 | contains a space and is NOT quoted. So to use $SMARTD_DEVICESTRING in a | |
1279 | bash script you should probably enclose it in double quotes. | |
832b75ed GG |
1280 | .IP \fBSMARTD_FAILTYPE\fP 4 |
1281 | gives the reason for the warning or message email. The possible values that | |
1282 | it takes and their meanings are: | |
1283 | .nf | |
1284 | .fi | |
1285 | \fIEmailTest\fP: this is an email test message. | |
1286 | .nf | |
1287 | .fi | |
1288 | \fIHealth\fP: the SMART health status indicates imminent failure. | |
1289 | .nf | |
1290 | .fi | |
1291 | \fIUsage\fP: a usage Attribute has failed. | |
1292 | .nf | |
1293 | .fi | |
1294 | \fISelfTest\fP: the number of self-test failures has increased. | |
1295 | .nf | |
1296 | .fi | |
1297 | \fIErrorCount\fP: the number of errors in the ATA error log has increased. | |
1298 | .nf | |
1299 | .fi | |
1300 | \fICurrentPendingSector\fP: one of more disk sectors could not be | |
1301 | read and are marked to be reallocated (replaced with spare sectors). | |
1302 | .nf | |
1303 | .fi | |
1304 | \fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing, | |
1305 | one or more disk sectors could not be read. | |
1306 | .nf | |
1307 | .fi | |
1308 | \fIFailedHealthCheck\fP: the SMART health status command failed. | |
1309 | .nf | |
1310 | .fi | |
1311 | \fIFailedReadSmartData\fP: the command to read SMART Attribute data failed. | |
1312 | .nf | |
1313 | .fi | |
1314 | \fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed. | |
1315 | .nf | |
1316 | .fi | |
1317 | \fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed. | |
1318 | .nf | |
1319 | .fi | |
1320 | \fIFailedOpenDevice\fP: the open() command to the device failed. | |
1321 | .IP \fBSMARTD_ADDRESS\fP 4 | |
1322 | is determined by the address argument ADD of the \'\-m\' Directive. | |
1323 | If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set. | |
1324 | Otherwise, it is set to the comma-separated-list of email addresses | |
1325 | given by the argument ADD, with the commas replaced by spaces | |
1326 | (example:admin@example.com root). If more than one email address is | |
1327 | given, then this string will contain space characters and is NOT | |
1328 | quoted, so to use it in a bash script you may want to enclose it in | |
1329 | double quotes. | |
1330 | .IP \fBSMARTD_MESSAGE\fP 4 | |
1331 | is set to the one sentence summary warning email message string from | |
1332 | \fBsmartd\fP. | |
1333 | This message string contains space characters and is NOT quoted. So to | |
1334 | use $SMARTD_MESSAGE in a bash script you should probably enclose it in | |
1335 | double quotes. | |
1336 | .IP \fBSMARTD_FULLMESSAGE\fP 4 | |
1337 | is set to the contents of the entire email warning message string from | |
1338 | \fBsmartd\fP. | |
1339 | This message string contains space and return characters and is NOT quoted. So to | |
1340 | use $SMARTD_FULLMESSAGE in a bash script you should probably enclose it in | |
1341 | double quotes. | |
1342 | .IP \fBSMARTD_TFIRST\fP 4 | |
1343 | is a text string giving the time and date at which the first problem | |
1344 | of this type was reported. This text string contains space characters | |
1345 | and no newlines, and is NOT quoted. For example: | |
1346 | .nf | |
1347 | .fi | |
1348 | Sun Feb 9 14:58:19 2003 CST | |
1349 | .IP \fBSMARTD_TFIRSTEPOCH\fP 4 | |
1350 | is an integer, which is the unix epoch (number of seconds since Jan 1, | |
1351 | 1970) for \fBSMARTD_TFIRST\fP. | |
1352 | .RE | |
1353 | .\" The following two lines are a workaround for a man2html bug. Please leave them. | |
1354 | .\" They define a non-existent option; useful because man2html can't correctly reset the margins. | |
1355 | .TP | |
1356 | .B \& | |
1357 | The shell which is used to run PATH is system-dependent. For vanilla | |
1358 | Linux/glibc it\'s bash. For other systems, the man page for | |
1359 | \fBpopen\fP(3) should say what shell is used. | |
1360 | ||
1361 | If the \'\-m ADD\' Directive is given with a normal address argument, | |
1362 | then the executable pointed to by PATH will be run in a shell with | |
1363 | STDIN receiving the body of the email message, and with the same | |
1364 | command-line arguments: | |
1365 | .nf | |
1366 | -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS | |
1367 | .fi | |
1368 | that would normally be provided to \'mail\'. Examples include: | |
1369 | .nf | |
1370 | .B -m user@home -M exec /bin/mail | |
1371 | .B -m admin@work -M exec /usr/local/bin/mailto | |
1372 | .B -m root -M exec /Example_1/bash/script/below | |
1373 | .fi | |
1374 | ||
1375 | Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is | |
1376 | used: | |
1377 | .nf | |
1378 | - -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS" | |
1379 | .fi | |
1380 | ||
1381 | If the \'\-m ADD\' Directive is given with the special address argument | |
1382 | .B <nomailer> | |
1383 | then the executable pointed to by PATH is run in a shell with | |
1384 | .B no | |
1385 | STDIN and | |
1386 | .B no | |
1387 | command-line arguments, for example: | |
1388 | .nf | |
1389 | .B -m <nomailer> -M exec /Example_2/bash/script/below | |
1390 | .fi | |
1391 | If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP | |
1392 | assumes that something is going wrong, and a snippet of that output | |
1393 | will be copied to SYSLOG. The remainder of the output is then | |
1394 | discarded. | |
1395 | ||
1396 | Some EXAMPLES of scripts that can be used with the \'\-M exec\' | |
1397 | Directive are given below. Some sample scripts are also included in | |
1398 | /usr/local/share/doc/smartmontools-5.1/examplescripts/. | |
1399 | ||
1400 | .TP | |
1401 | .B \-f | |
1402 | Check for \'failure\' of any Usage Attributes. If these Attributes are | |
1403 | less than or equal to the threshold, it does NOT indicate imminent | |
1404 | disk failure. It "indicates an advisory condition where the usage or | |
1405 | age of the device has exceeded its intended design life period." | |
1406 | [Please see the \fBsmartctl \-A\fP command-line option.] | |
1407 | .TP | |
1408 | .B \-p | |
1409 | Report anytime that a Prefail Attribute has changed | |
1410 | its value since the last check, 30 minutes ago. [Please see the | |
1411 | .B smartctl \-A | |
1412 | command-line option.] | |
1413 | .TP | |
1414 | .B \-u | |
1415 | Report anytime that a Usage Attribute has changed its value | |
1416 | since the last check, 30 minutes ago. [Please see the | |
1417 | .B smartctl \-A | |
1418 | command-line option.] | |
1419 | .TP | |
1420 | .B \-t | |
1421 | Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'. | |
1422 | Tracks changes in \fIall\fP device Attributes (both Prefailure and | |
1423 | Usage). [Please see the \fBsmartctl\fP \-A command-line option.] | |
1424 | .TP | |
1425 | .B \-i ID | |
1426 | Ignore device Attribute number \fBID\fP when checking for failure of | |
1427 | Usage Attributes. \fBID\fP must be a decimal integer in the range | |
1428 | from 1 to 255. This Directive modifies the behavior of the \'\-f\' | |
1429 | Directive and has no effect without it. | |
1430 | ||
1431 | This is useful, for example, if you have a very old disk and don\'t | |
1432 | want to keep getting messages about the hours-on-lifetime Attribute | |
1433 | (usually Attribute 9) failing. This Directive may appear multiple | |
1434 | times for a single device, if you want to ignore multiple Attributes. | |
1435 | .TP | |
1436 | .B \-I ID | |
1437 | Ignore device Attribute \fBID\fP when tracking changes in the | |
1438 | Attribute values. \fBID\fP must be a decimal integer in the range | |
1439 | from 1 to 255. This Directive modifies the behavior of the \'\-p\', | |
1440 | \'\-u\', and \'\-t\' tracking Directives and has no effect without one | |
1441 | of them. | |
1442 | ||
1443 | This is useful, for example, if one of the device Attributes is the disk | |
1444 | temperature (usually Attribute 194 or 231). It\'s annoying to get reports | |
1445 | each time the temperature changes. This Directive may appear multiple | |
1446 | times for a single device, if you want to ignore multiple Attributes. | |
1447 | .TP | |
2127e193 | 1448 | .B \-r ID[!] |
832b75ed GG |
1449 | When tracking, report the \fIRaw\fP value of Attribute \fBID\fP along |
1450 | with its (normally reported) \fINormalized\fP value. \fBID\fP must be | |
1451 | a decimal integer in the range from 1 to 255. This Directive modifies | |
1452 | the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives | |
1453 | and has no effect without one of them. This Directive may be given | |
1454 | multiple times. | |
1455 | ||
1456 | A common use of this Directive is to track the device Temperature | |
1457 | (often ID=194 or 231). | |
1458 | ||
2127e193 GI |
1459 | If the optional flag \'!\' is appended, a change of the Normalized |
1460 | value is considered critical. The report will be logged as LOG_CRIT | |
1461 | and a warning email will be sent if \'-m\' is specified. | |
1462 | ||
832b75ed | 1463 | .TP |
2127e193 | 1464 | .B \-R ID[!] |
832b75ed GG |
1465 | When tracking, report whenever the \fIRaw\fP value of Attribute |
1466 | \fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes | |
1467 | of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal | |
1468 | integer in the range from 1 to 255. This Directive modifies the | |
1469 | behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and | |
1470 | has no effect without one of them. This Directive may be given | |
1471 | multiple times. | |
1472 | ||
1473 | If this Directive is given, it automatically implies the \'\-r\' | |
1474 | Directive for the same Attribute, so that the Raw value of the | |
1475 | Attribute is reported. | |
1476 | ||
1477 | A common use of this Directive is to track the device Temperature | |
1478 | (often ID=194 or 231). It is also useful for understanding how | |
1479 | different types of system behavior affects the values of certain | |
1480 | Attributes. | |
1481 | ||
2127e193 GI |
1482 | If the optional flag \'!\' is appended, a change of the Raw |
1483 | value is considered critical. The report will be logged as | |
1484 | LOG_CRIT and a warning email will be sent if \'-m\' is specified. | |
1485 | An example is \'-R 5!\' to warn when new sectors are reallocated. | |
1486 | ||
832b75ed | 1487 | .TP |
2127e193 | 1488 | .B \-C ID[+] |
832b75ed GG |
1489 | [ATA only] Report if the current number of pending sectors is |
1490 | non-zero. Here \fBID\fP is the id number of the Attribute whose raw | |
1491 | value is the Current Pending Sector count. The allowed range of | |
1492 | \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use | |
1493 | ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to | |
1494 | \fB\-C 197\fP (since Attribute 197 is generally used to monitor | |
1495 | pending sectors). | |
1496 | ||
2127e193 GI |
1497 | If \'+\' is specified, a report is only printed if the number of sectors |
1498 | has increased between two check cycles. Some disks do not reset this | |
1499 | attribute when a bad sector is reallocated. | |
1500 | See also \'\-v 197,increasing\' below. | |
1501 | ||
832b75ed GG |
1502 | A pending sector is a disk sector (containing 512 bytes of your data) |
1503 | which the device would like to mark as ``bad" and reallocate. | |
1504 | Typically this is because your computer tried to read that sector, and | |
1505 | the read failed because the data on it has been corrupted and has | |
1506 | inconsistent Error Checking and Correction (ECC) codes. This is | |
1507 | important to know, because it means that there is some unreadable data | |
1508 | on the disk. The problem of figuring out what file this data belongs | |
1509 | to is operating system and file system specific. You can typically | |
1510 | force the sector to reallocate by writing to it (translation: make the | |
1511 | device substitute a spare good sector for the bad one) but at the | |
1512 | price of losing the 512 bytes of data stored there. | |
1513 | ||
1514 | .TP | |
2127e193 | 1515 | .B \-U ID[+] |
832b75ed GG |
1516 | [ATA only] Report if the number of offline uncorrectable sectors is |
1517 | non-zero. Here \fBID\fP is the id number of the Attribute whose raw | |
1518 | value is the Offline Uncorrectable Sector count. The allowed range of | |
1519 | \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use | |
1520 | ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to | |
1521 | \fB\-U 198\fP (since Attribute 198 is generally used to monitor | |
1522 | offline uncorrectable sectors). | |
1523 | ||
2127e193 GI |
1524 | If \'+\' is specified, a report is only printed if the number of sectors |
1525 | has increased since the last check cycle. Some disks do not reset this | |
1526 | attribute when a bad sector is reallocated. | |
1527 | See also \'\-v 198,increasing\' below. | |
832b75ed GG |
1528 | |
1529 | An offline uncorrectable sector is a disk sector which was not | |
1530 | readable during an off\-line scan or a self\-test. This is important | |
1531 | to know, because if you have data stored in this disk sector, and you | |
1532 | need to read it, the read will fail. Please see the previous \'\-C\' | |
1533 | option for more details. | |
1534 | ||
4d59bff9 GG |
1535 | .TP |
1536 | .B \-W DIFF[,INFO[,CRIT]] | |
1537 | Report if the current temperature had changed by at least \fBDIFF\fP | |
2127e193 GI |
1538 | degrees since last report, or if new min or max temperature is detected. |
1539 | Report or Warn if the temperature is greater or equal than one of | |
1540 | \fBINFO\fP or \fBCRIT\fP degrees Celsius. | |
1541 | If the limit \fBCRIT\fP is reached, a message with loglevel | |
4d59bff9 GG |
1542 | \fB\'LOG_CRITICAL\'\fP will be logged to syslog and a warning email |
1543 | will be send if '-m' is specified. If only the limit \fBINFO\fP is | |
1544 | reached, a message with loglevel \fB\'LOG_INFO\'\fP will be logged. | |
1545 | ||
2127e193 GI |
1546 | If this directive is used in conjunction with state persistence |
1547 | (\'\-s\' option), the min and max temperature values are preserved | |
1548 | across boot cycles. The minimum temperature value is not updated | |
1549 | during the first 30 minutes after startup. | |
1550 | ||
4d59bff9 GG |
1551 | To disable any of the 3 reports, set the corresponding limit to 0. |
1552 | Trailing zero arguments may be omitted. By default, all temperature | |
1553 | reports are disabled (\'-W 0\'). | |
1554 | ||
1555 | To track temperature changes of at least 2 degrees, use: | |
1556 | .nf | |
1557 | \fB \-W 2 | |
1558 | .fi | |
1559 | To log informal messages on temperatures of at least 40 degrees, use: | |
1560 | .nf | |
1561 | \fB \-W 0,40 | |
1562 | .fi | |
1563 | For warning messages/mails on temperatures of at least 45 degrees, use: | |
1564 | .nf | |
1565 | \fB \-W 0,0,45 | |
1566 | .fi | |
1567 | To combine all of the above reports, use: | |
1568 | .nf | |
1569 | \fB \-W 2,40,45 | |
1570 | .fi | |
1571 | ||
1572 | For ATA devices, smartd interprets Attribute 194 as Temperature Celsius | |
1573 | by default. This can be changed to Attribute 9 or 220 by the drive | |
1574 | database or by the \'-v\' directive, see below. | |
1575 | ||
832b75ed GG |
1576 | .TP |
1577 | .B \-F TYPE | |
1578 | [ATA only] Modifies the behavior of \fBsmartd\fP to compensate for | |
1579 | some known and understood device firmware bug. The arguments to this | |
1580 | Directive are exclusive, so that only the final Directive given is | |
1581 | used. The valid values are: | |
1582 | ||
1583 | .I none | |
1584 | \- Assume that the device firmware obeys the ATA specifications. This is | |
1585 | the default, unless the device has presets for \'\-F\' in the device | |
1586 | database. | |
1587 | ||
1588 | .I samsung | |
1589 | \- In some Samsung disks (example: model SV4012H Firmware Version: | |
1590 | RM100-08) some of the two- and four-byte quantities in the SMART data | |
1591 | structures are byte-swapped (relative to the ATA specification). | |
1592 | Enabling this option tells \fBsmartd\fP to evaluate these quantities | |
1593 | in byte-reversed order. Some signs that your disk needs this option | |
1594 | are (1) no self-test log printed, even though you have run self-tests; | |
1595 | (2) very large numbers of ATA errors reported in the ATA error log; | |
1596 | (3) strange and impossible values for the ATA error log timestamps. | |
1597 | ||
1598 | .I samsung2 | |
1599 | \- In more recent Samsung disks (firmware revisions ending in "\-23") the | |
1600 | number of ATA errors reported is byte swapped. Enabling this option | |
1601 | tells \fBsmartd\fP to evaluate this quantity in byte-reversed order. | |
1602 | ||
a37e7145 GG |
1603 | .I samsung3 |
1604 | \- Some Samsung disks (at least SP2514N with Firmware VF100\-37) report | |
1605 | a self\-test still in progress with 0% remaining when the test was already | |
1606 | completed. If this directive is specified, \fBsmartd\fP will not skip the | |
1607 | next scheduled self\-test (see Directive \'\-s\' above) in this case. | |
1608 | ||
832b75ed GG |
1609 | Note that an explicit \'\-F\' Directive will over-ride any preset |
1610 | values for \'\-F\' (see the \'\-P\' option below). | |
1611 | ||
1612 | ||
1613 | [Please see the \fBsmartctl \-F\fP command-line option.] | |
1614 | ||
1615 | .TP | |
a23d5117 GI |
1616 | .B \-v ID,FORMAT[:BYTEORDER][,NAME] |
1617 | [ATA only] Sets a vendor\-specific raw value print FORMAT, an optional | |
1618 | BYTEORDER and an optional NAME for Attribute ID. | |
bed94269 GI |
1619 | This directive may be used multiple times. |
1620 | Please see \fBsmartctl -v\fP command-line option for further details. | |
832b75ed | 1621 | |
bed94269 | 1622 | The following arguments affect smartd warning output: |
832b75ed | 1623 | |
2127e193 GI |
1624 | .I 197,increasing |
1625 | \- Raw Attribute number 197 (Current Pending Sector Count) is not | |
bed94269 GI |
1626 | reset if uncorrectable sectors are reallocated. This sets \'-C 197+\' |
1627 | if no other \'-C\' directive is specified. | |
2127e193 GI |
1628 | |
1629 | .I 198,increasing | |
1630 | \- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not | |
bed94269 GI |
1631 | reset if uncorrectable sector are reallocated. This sets \'-U 198+\' |
1632 | if no other \'-U\' directive is specified. | |
832b75ed GG |
1633 | |
1634 | .TP | |
1635 | .B \-P TYPE | |
1636 | Specifies whether | |
1637 | \fBsmartd\fP | |
1638 | should use any preset options that are available for this drive. The | |
1639 | valid arguments to this Directive are: | |
1640 | ||
1641 | .I use | |
1642 | \- use any presets that are available for this drive. This is the default. | |
1643 | ||
1644 | .I ignore | |
1645 | \- do not use any presets for this drive. | |
1646 | ||
1647 | .I show | |
1648 | \- show the presets listed for this drive in the database. | |
1649 | ||
1650 | .I showall | |
1651 | \- show the presets that are available for all drives and then exit. | |
1652 | ||
1653 | [Please see the | |
1654 | .B smartctl \-P | |
1655 | command-line option.] | |
1656 | ||
1657 | .TP | |
1658 | .B \-a | |
1659 | Equivalent to turning on all of the following Directives: | |
1660 | .B \'\-H\' | |
1661 | to check the SMART health status, | |
1662 | .B \'\-f\' | |
1663 | to report failures of Usage (rather than Prefail) Attributes, | |
1664 | .B \'\-t\' | |
1665 | to track changes in both Prefailure and Usage Attributes, | |
1666 | .B \'\-l\ selftest\' | |
1667 | to report increases in the number of Self-Test Log errors, | |
1668 | .B \'\-l\ error\' | |
1669 | to report increases in the number of ATA errors, | |
1670 | .B \'\-C 197\' | |
1671 | to report nonzero values of the current pending sector count, and | |
1672 | .B \'\-U 198\' | |
1673 | to report nonzero values of the offline pending sector count. | |
1674 | ||
1675 | Note that \-a is the default for ATA devices. If none of these other | |
1676 | Directives is given, then \-a is assumed. | |
1677 | ||
1678 | .TP | |
1679 | .B # | |
1680 | Comment: ignore the remainder of the line. | |
1681 | .TP | |
1682 | .B \e | |
1683 | Continuation character: if this is the last non-white or non-comment | |
1684 | character on a line, then the following line is a continuation of the current | |
1685 | one. | |
1686 | .PP | |
1687 | If you are not sure which Directives to use, I suggest experimenting | |
1688 | for a few minutes with | |
1689 | .B smartctl | |
1690 | to see what SMART functionality your disk(s) support(s). If you do | |
1691 | not like voluminous syslog messages, a good choice of | |
1692 | \fBsmartd\fP | |
1693 | configuration file Directives might be: | |
1694 | .nf | |
1695 | .B \-H \-l\ selftest \-l\ error \-f. | |
1696 | .fi | |
1697 | If you want more frequent information, use: | |
1698 | .B -a. | |
1699 | ||
1700 | .TP | |
1701 | .B ADDITIONAL DETAILS ABOUT DEVICESCAN | |
1702 | If the first non-comment entry in the configuration file is the text | |
1703 | string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will | |
1704 | ignore any remaining lines in the configuration file, and will scan | |
1705 | for devices. | |
1706 | ||
1707 | If \fBDEVICESCAN\fP is not followed by any Directives, then smartd | |
1708 | will scan for both ATA and SCSI devices, and will monitor all possible | |
1709 | SMART properties of any devices that are found. | |
1710 | ||
1711 | \fBDEVICESCAN\fP may optionally be followed by any valid Directives, | |
1712 | which will be applied to all devices that are found in the scan. For | |
1713 | example | |
1714 | .nf | |
1715 | .B DEVICESCAN -m root@example.com | |
1716 | .fi | |
1717 | will scan for all devices, and then monitor them. It will send one | |
1718 | email warning per device for any problems that are found. | |
1719 | .nf | |
1720 | .B DEVICESCAN -d ata -m root@example.com | |
1721 | .fi | |
1722 | will do the same, but restricts the scan to ATA devices only. | |
1723 | .nf | |
1724 | .B DEVICESCAN -H -d ata -m root@example.com | |
1725 | .fi | |
1726 | will do the same, but only monitors the SMART health status of the | |
1727 | devices, (rather than the default \-a, which monitors all SMART | |
1728 | properties). | |
1729 | ||
1730 | .TP | |
1731 | .B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\' | |
1732 | These are two examples of shell scripts that can be used with the \'\-M | |
1733 | exec PATH\' Directive described previously. The paths to these scripts | |
1734 | and similar executables is the PATH argument to the \'\-M exec PATH\' | |
1735 | Directive. | |
1736 | ||
1737 | Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'. It appends | |
1738 | the output of | |
1739 | .B smartctl -a | |
1740 | to the output of the smartd email warning message and sends it to ADDRESS. | |
1741 | ||
1742 | .nf | |
1743 | \fB | |
1744 | #! /bin/bash | |
1745 | ||
1746 | # Save the email message (STDIN) to a file: | |
1747 | cat > /root/msg | |
1748 | ||
1749 | # Append the output of smartctl -a to the message: | |
1750 | /usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg | |
1751 | ||
1752 | # Now email the message to the user at address ADD: | |
1753 | /bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg | |
1754 | \fP | |
1755 | .fi | |
1756 | ||
1757 | Example 2: This script is for use with \'\-m <nomailer> \-M exec | |
1758 | PATH\'. It warns all users about a disk problem, waits 30 seconds, and | |
1759 | then powers down the machine. | |
1760 | ||
1761 | .nf | |
1762 | \fB | |
1763 | #! /bin/bash | |
1764 | ||
1765 | # Warn all users of a problem | |
1766 | wall \'Problem detected with disk: \' "$SMARTD_DEVICESTRING" | |
1767 | wall \'Warning message from smartd is: \' "$SMARTD_MESSAGE" | |
1768 | wall \'Shutting down machine in 30 seconds... \' | |
1769 | ||
1770 | # Wait half a minute | |
1771 | sleep 30 | |
1772 | ||
1773 | # Power down the machine | |
1774 | /sbin/shutdown -hf now | |
1775 | \fP | |
1776 | .fi | |
1777 | ||
1778 | Some example scripts are distributed with the smartmontools package, | |
1779 | in /usr/local/share/doc/smartmontools-5.1/examplescripts/. | |
1780 | ||
1781 | Please note that these scripts typically run as root, so any files | |
1782 | that they read/write should not be writable by ordinary users or | |
1783 | reside in directories like /tmp that are writable by ordinary users | |
1784 | and may expose your system to symlink attacks. | |
1785 | ||
1786 | As previously described, if the scripts write to STDOUT or STDERR, | |
1787 | this is interpreted as indicating that there was an internal error | |
1788 | within the script, and a snippet of STDOUT/STDERR is logged to SYSLOG. | |
1789 | The remainder is flushed. | |
1790 | ||
1791 | .\" ENDINCLUDE | |
1792 | .\" DO NOT MODIFY THIS OR PREVIOUS/NEXT LINES. THIS DEFINES THE | |
1793 | .\" END OF THE INCLUDE SECTION FOR smartd.conf.5 | |
1794 | ||
1795 | .SH NOTES | |
1796 | \fBsmartd\fP | |
1797 | will make log entries at loglevel | |
1798 | .B LOG_INFO | |
1799 | if the Normalized SMART Attribute values have changed, as reported using the | |
1800 | .B \'\-t\', \'\-p\', | |
1801 | or | |
1802 | .B \'\-u\' | |
1803 | Directives. For example: | |
1804 | .nf | |
1805 | .B \'Device: /dev/hda, SMART Attribute: 194 Temperature_Celsius changed from 94 to 93\' | |
1806 | .fi | |
1807 | Note that in this message, the value given is the \'Normalized\' not the \'Raw\' | |
1808 | Attribute value (the disk temperature in this case is about 22 | |
1809 | Celsius). The | |
1810 | .B \'-R\' | |
1811 | and | |
1812 | .B \'-r\' | |
1813 | Directives modify this behavior, so that the information is printed | |
1814 | with the Raw values as well, for example: | |
1815 | .nf | |
1816 | .B \'Device: /dev/hda, SMART Attribute: 194 Temperature_Celsius changed from 94 [Raw 22] to 93 [Raw 23]\' | |
1817 | .fi | |
1818 | Here the Raw values are the actual disk temperatures in Celsius. The | |
1819 | way in which the Raw values are printed, and the names under which the | |
1820 | Attributes are reported, is governed by the various | |
1821 | .B \'-v Num,Description\' | |
1822 | Directives described previously. | |
1823 | ||
1824 | Please see the | |
1825 | .B smartctl | |
1826 | manual page for further explanation of the differences between | |
1827 | Normalized and Raw Attribute values. | |
1828 | ||
1829 | \fBsmartd\fP | |
1830 | will make log entries at loglevel | |
1831 | .B LOG_CRIT | |
1832 | if a SMART Attribute has failed, for example: | |
1833 | .nf | |
1834 | .B \'Device: /dev/hdc, Failed SMART Attribute: 5 Reallocated_Sector_Ct\' | |
1835 | .fi | |
1836 | This loglevel is used for reporting enabled by the | |
1837 | .B \'\-H\', \-f\', \'\-l\ selftest\', | |
1838 | and | |
1839 | .B \'\-l\ error\' | |
1840 | Directives. Entries reporting failure of SMART Prefailure Attributes | |
1841 | should not be ignored: they mean that the disk is failing. Use the | |
1842 | .B smartctl | |
1843 | utility to investigate. | |
1844 | ||
1845 | Under Solaris with the default \fB/etc/syslog.conf\fP configuration, | |
1846 | messages below loglevel \fBLOG_NOTICE\fP will \fBnot\fP be recorded. | |
1847 | Hence all \fBsmartd\fP messages with loglevel \fBLOG_INFO\fP will be | |
1848 | lost. If you want to use the existing daemon facility to log all | |
1849 | messages from \fBsmartd\fP, you should change \fB/etc/syslog.conf\fP | |
1850 | from: | |
1851 | .nf | |
1852 | ...;daemon.notice;... /var/adm/messages | |
1853 | .fi | |
1854 | to read: | |
1855 | .nf | |
1856 | ...;daemon.info;... /var/adm/messages | |
1857 | .fi | |
1858 | Alternatively, you can use a local facility to log messages: please | |
1859 | see the \fBsmartd\fP '-l' command-line option described above. | |
1860 | ||
1861 | On Cygwin and Windows, the log messages are written to the event log | |
1862 | or to a file. See documentation of the '-l FACILITY' option above for | |
1863 | details. | |
1864 | ||
1865 | On Windows, the following built-in commands can be used to control | |
1866 | \fBsmartd\fP, if running as a daemon: | |
1867 | ||
1868 | \'\fBsmartd status\fP\' \- check status | |
1869 | ||
1870 | \'\fBsmartd stop\fP\' \- stop smartd | |
1871 | ||
1872 | \'\fBsmartd reload\fP\' \- reread config file | |
1873 | ||
1874 | \'\fBsmartd restart\fP\' \- restart smartd | |
1875 | ||
1876 | \'\fBsmartd sigusr1\fP\' \- check disks now | |
1877 | ||
1878 | \'\fBsmartd sigusr2\fP\' \- toggle debug mode | |
1879 | ||
1880 | On WinNT4/2000/XP, \fBsmartd\fP can also be run as a Windows service: | |
1881 | ||
1882 | ||
1883 | The Cygwin Version of \fBsmartd\fP can be run as a service via the | |
1884 | cygrunsrv tool. The start-up script provides Cygwin-specific commands | |
1885 | to install and remove the service: | |
1886 | .nf | |
1887 | .B /usr/local/etc/rc.d/init.d/smartd install [options] | |
1888 | .B /usr/local/etc/rc.d/init.d/smartd remove | |
1889 | .fi | |
1890 | The service can be started and stopped by the start-up script as usual | |
1891 | (see \fBEXAMPLES\fP above). | |
1892 | ||
1893 | ||
1894 | The Windows Version of \fBsmartd\fP has buildin support for services: | |
1895 | ||
1896 | \'\fBsmartd install [options]\fP\' installs a service | |
1897 | named "smartd" (display name "SmartD Service") using the command line | |
1898 | \'/installpath/smartd.exe --service [options]\'. | |
1899 | ||
1900 | \'\fBsmartd remove\fP\' can later be used to remove the service entry | |
1901 | from registry. | |
1902 | ||
1903 | Upon startup, the smartd service changes the working directory | |
1904 | to its own installation path. If smartd.conf and blat.exe are stored | |
1905 | in this directory, no \'-c\' option and \'-M exec\' directive is needed. | |
1906 | ||
1907 | The debug mode (\'-d\', \'-q onecheck\') does not work if smartd is | |
1908 | running as service. | |
1909 | ||
1910 | The service can be controlled as usual with Windows commands \'net\' | |
1911 | or \'sc\' (\'\fBnet start smartd\fP\', \'\fBnet stop smartd\fP\'). | |
1912 | ||
1913 | Pausing the service (\'\fBnet pause smartd\fP\') sets the interval between | |
1914 | disk checks (\'-i N\') to infinite. | |
1915 | ||
1916 | Continuing the paused service (\'\fBnet continue smartd\fP\') resets the | |
1917 | interval and rereads the configuration file immediately (like \fBSIGHUP\fP): | |
1918 | ||
1919 | Continuing a still running service (\'\fBnet continue smartd\fP\' without | |
1920 | preceding \'\fBnet pause smartd\fP\') does not reread configuration but | |
1921 | checks disks immediately (like \fBSIGUSR1\fP). | |
1922 | ||
1923 | .SH LOG TIMESTAMP TIMEZONE | |
1924 | ||
1925 | When \fBsmartd\fP makes log entries, these are time-stamped. The time | |
1926 | stamps are in the computer's local time zone, which is generally set | |
1927 | using either the environment variable \'\fBTZ\fP\' or using a | |
1928 | time-zone file such as \fB/etc/localtime\fP. You may wish to change | |
1929 | the timezone while \fBsmartd\fP is running (for example, if you carry | |
1930 | a laptop to a new time-zone and don't reboot it). Due to a bug in the | |
1931 | \fBtzset(3)\fP function of many unix standard C libraries, the | |
1932 | time-zone stamps of \fBsmartd\fP might not change. For some systems, | |
1933 | \fBsmartd\fP will work around this problem \fIif\fP the time-zone is | |
1934 | set using \fB/etc/localtime\fP. The work-around \fIfails\fP if the | |
1935 | time-zone is set using the \'\fBTZ\fP\' variable (or a file that it | |
1936 | points to). | |
1937 | ||
1938 | ||
1939 | .SH RETURN VALUES | |
1940 | The return value (exit status) of | |
1941 | \fBsmartd\fP | |
1942 | can have the following values: | |
1943 | .TP | |
1944 | .B 0: | |
1945 | Daemon startup successful, or \fBsmartd\fP was killed by a SIGTERM (or in debug mode, a SIGQUIT). | |
1946 | .TP | |
1947 | .B 1: | |
1948 | Commandline did not parse. | |
1949 | .TP | |
1950 | .B 2: | |
1951 | There was a syntax error in the config file. | |
1952 | .TP | |
1953 | .B 3: | |
1954 | Forking the daemon failed. | |
1955 | .TP | |
1956 | .B 4: | |
1957 | Couldn\'t create PID file. | |
1958 | .TP | |
1959 | .B 5: | |
1960 | Config file does not exist (only returned in conjunction with the \'-c\' option). | |
1961 | .TP | |
1962 | .B 6: | |
1963 | Config file exists, but cannot be read. | |
1964 | .TP | |
1965 | .B 8: | |
1966 | \fBsmartd\fP | |
1967 | ran out of memory during startup. | |
1968 | .TP | |
1969 | .B 9: | |
1970 | A compile time constant of\fB smartd\fP was too small. This can be caused by an | |
1971 | excessive number of disks, or by lines in \fB /usr/local/etc/smartd.conf\fP that are too long. | |
1972 | Please report this problem to \fB smartmontools-support@lists.sourceforge.net\fP. | |
1973 | .TP | |
1974 | .B 10 | |
1975 | An inconsistency was found in \fBsmartd\fP\'s internal data | |
1976 | structures. This should never happen. It must be due to either a | |
1977 | coding or compiler bug. \fIPlease\fP report such failures to | |
1978 | smartmontools-support@lists.sourceforge.net. | |
1979 | .TP | |
1980 | .B 16: | |
1981 | A device explicitly listed in | |
1982 | .B /usr/local/etc/smartd.conf | |
1983 | can\'t be monitored. | |
1984 | .TP | |
1985 | .B 17: | |
1986 | \fBsmartd\fP | |
1987 | didn\'t find any devices to monitor. | |
1988 | .TP | |
1989 | .B 254: | |
1990 | When in daemon mode, | |
1991 | \fBsmartd\fP | |
1992 | received a SIGINT or SIGQUIT. (Note that in debug mode, SIGINT has | |
1993 | the same effect as SIGHUP, and makes \fBsmartd\fP reload its | |
1994 | configuration file. SIGQUIT has the same effect as SIGTERM and causes | |
1995 | \fBsmartd\fP to exit with zero exit status. | |
1996 | .TP | |
1997 | .B 132 and above | |
1998 | \fBsmartd\fP | |
1999 | was killed by a signal that is not explicitly listed above. The exit | |
2000 | status is then 128 plus the signal number. For example if | |
2001 | \fBsmartd\fP | |
2002 | is killed by SIGKILL (signal 9) then the exit status is 137. | |
2003 | ||
2004 | .PP | |
2005 | .SH AUTHOR | |
2006 | \fBBruce Allen\fP smartmontools-support@lists.sourceforge.net | |
2007 | .fi | |
2008 | University of Wisconsin \- Milwaukee Physics Department | |
2009 | ||
2010 | .PP | |
2011 | .SH CONTRIBUTORS | |
2012 | The following have made large contributions to smartmontools: | |
2013 | .nf | |
2014 | \fBCasper Dik\fP (Solaris SCSI interface) | |
2127e193 | 2015 | \fBChristian Franke\fP (Windows interface, C++ redesign, USB support, ...) |
832b75ed GG |
2016 | \fBDouglas Gilbert\fP (SCSI subsystem) |
2017 | \fBGuido Guenther\fP (Autoconf/Automake packaging) | |
2018 | \fBGeoffrey Keating\fP (Darwin ATA interface) | |
2019 | \fBEduard Martinescu\fP (FreeBSD interface) | |
2020 | \fBFr\*'ed\*'eric L. W. Meunier\fP (Web site and Mailing list) | |
2127e193 | 2021 | \fBGabriele Pohl\fP (Web site and Wiki, conversion from CVS to SVN) |
832b75ed | 2022 | \fBKeiji Sawada\fP (Solaris ATA interface) |
2127e193 | 2023 | \fBManfred Schwarb\fP (Drive database) |
832b75ed GG |
2024 | \fBSergey Svishchev\fP (NetBSD interface) |
2025 | \fBDavid Snyder and Sergey Svishchev\fP (OpenBSD interface) | |
2026 | \fBPhil Williams\fP (User interface and drive database) | |
2127e193 | 2027 | \fBShengfeng Zhou\fP (Linux/FreeBSD HighPoint RocketRAID interface) |
832b75ed GG |
2028 | .fi |
2029 | Many other individuals have made smaller contributions and corrections. | |
2030 | ||
2031 | .PP | |
2032 | .SH CREDITS | |
2033 | .fi | |
2034 | This code was derived from the smartsuite package, written by Michael | |
2035 | Cornwell, and from the previous ucsc smartsuite package. It extends | |
2036 | these to cover ATA-5 disks. This code was originally developed as a | |
2037 | Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory | |
2038 | (now part of the Storage Systems Research Center), Jack Baskin School | |
2039 | of Engineering, University of California, Santa | |
2040 | Cruz. \fBhttp://ssrc.soe.ucsc.edu/\fP . | |
2041 | .SH | |
2042 | HOME PAGE FOR SMARTMONTOOLS: | |
2043 | .fi | |
2044 | Please see the following web site for updates, further documentation, bug | |
2045 | reports and patches: \fBhttp://smartmontools.sourceforge.net/\fP | |
2046 | ||
2047 | .SH SEE ALSO: | |
2048 | \fBsmartd.conf\fP(5), \fBsmartctl\fP(8), \fBsyslogd\fP(8), | |
2049 | \fBsyslog.conf\fP(5), \fBbadblocks\fP(8), \fBide\-smart\fP(8), \fBregex\fP(7). | |
2050 | ||
2051 | .SH | |
2052 | REFERENCES FOR SMART | |
2053 | .fi | |
2054 | An introductory article about smartmontools is \fIMonitoring Hard | |
2055 | Disks with SMART\fP, by Bruce Allen, Linux Journal, January 2004, | |
2056 | pages 74-77. This is \fBhttp://www.linuxjournal.com/article.php?sid=6983\fP | |
2057 | online. | |
2058 | ||
2059 | If you would like to understand better how SMART works, and what it | |
2060 | does, a good place to start is with Sections 4.8 and 6.54 of the first | |
2061 | volume of the \'AT Attachment with Packet Interface-7\' (ATA/ATAPI-7) | |
2062 | specification. This documents the SMART functionality which the | |
2063 | \fBsmartmontools\fP utilities provide access to. You can find | |
2064 | Revision 4b of this document at | |
2065 | \fBhttp://www.t13.org/docs2004/d1532v1r4b-ATA-ATAPI-7.pdf\fP . | |
2066 | Earlier and later versions of this Specification are available from | |
2067 | the T13 web site \fBhttp://www.t13.org/\fP . | |
2068 | ||
2069 | .fi | |
2070 | The functioning of SMART was originally defined by the SFF-8035i | |
2071 | revision 2 and the SFF-8055i revision 1.4 specifications. These are | |
2072 | publications of the Small Form Factors (SFF) Committee. Links to | |
2073 | these documents may be found in the References section of the | |
2074 | smartmontools home page at \fBhttp://smartmontools.sourceforge.net/#references\fP . | |
2075 | ||
2076 | .SH | |
2127e193 | 2077 | SVN ID OF THIS PAGE: |
a23d5117 | 2078 | $Id: smartd.8.in 3057 2010-02-03 20:56:41Z chrfranke $ |