2 Copyright (C) 2002-6 Bruce Allen <smartmontools-support@lists.sourceforge.net>
4 $Id: smartd.conf.5.in,v 1.73 2006/04/12 14:03:14 ballen4705 Exp $
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
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., 675
13 Mass Ave, Cambridge, MA 02139, USA.
15 This code was originally developed as a Senior Thesis by Michael Cornwell
16 at the Concurrent Systems Laboratory (now part of the Storage Systems
17 Research Center), Jack Baskin School of Engineering, University of
18 California, Santa Cruz. http://ssrc.soe.ucsc.edu/
20 .TH SMARTD.CONF 5 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE
22 \fBsmartd.conf\fP \- SMART Disk Monitoring Daemon Configuration File\fP
25 .B /usr/local/etc/smartd.conf
28 CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME
31 \fB/usr/local/etc/smartd.conf\fP is the configuration file for the \fBsmartd\fP
32 daemon, which monitors the Self-Monitoring, Analysis and Reporting
33 Technology (SMART) system built into many ATA-3 and later ATA, IDE and
36 If the configuration file \fB/usr/local/etc/smartd.conf\fP is present,
37 \fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the
38 background. If \fBsmartd\fP subsequently receives a \fBHUP\fP signal,
39 it will then re-read the configuration file. If \fBsmartd\fP is
40 running in debug mode, then an \fBINT\fP signal will also make it
41 re-read the configuration file. This signal can be generated by typing
42 \fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is
45 .\" DO NOT MODIFY THIS OR THE FOLLOWING TWO LINES. WHAT FOLLOWS
46 .\" IS AUTOMATICALLY INCLUDED FROM THE FILE smartd.8.in
49 .SH CONFIGURATION FILE /usr/local/etc/smartd.conf
50 In the absence of a configuration file, under Linux
52 will try to open the 20 ATA devices
54 and the 26 SCSI devices
58 will try to open all existing ATA devices (with entries in /dev)
60 and all existing SCSI devices
64 will try to open all existing ATA devices (with entries in /dev)
66 and all existing SCSI devices
68 Under Solaris \fBsmartd\fP will try to open all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk
69 devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.
70 Under Windows \fBsmartd\fP will try to open all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")
71 for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP
72 (bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,
73 and \fB"/dev/scsi[0-9][0-7]"\fP (ASPI adapter 0-9, ID 0-7) for SCSI
74 devices on all versions of Windows.
75 Under Darwin, \fBsmartd\fP will open any ATA block storage device.
77 This can be annoying if you have an ATA or SCSI device that hangs or
78 misbehaves when receiving SMART commands. Even if this causes no
79 problems, you may be annoyed by the string of error log messages about
80 block-major devices that can\'t be found, and SCSI devices that can\'t
83 One can avoid this problem, and gain more control over the types of
86 by using the configuration file
87 .B /usr/local/etc/smartd.conf.
88 This file contains a list of devices to monitor, with one device per
89 line. An example file is included with the
91 distribution. You will find this sample configuration file in
92 \fB/usr/local/share/doc/smartmontools-5.1/\fP. For security, the configuration file
93 should not be writable by anyone but root. The syntax of the file is as
96 There should be one device listed per line, although you may have
97 lines that are entirely comments or white space.
99 Any text following a hash sign \'#\' and up to the end of the line is
100 taken to be a comment, and ignored.
102 Lines may be continued by using a backslash \'\e\' as the last
103 non-whitespace or non-comment item on a line.
105 Note: a line whose first character is a hash sign \'#\' is treated as
106 a white-space blank line, \fBnot\fP as a non-existent line, and will
107 \fBend\fP a continuation line.
110 Here is an example configuration file. It\'s for illustrative purposes
111 only; please don\'t copy it onto your system without reading to the end
117 .B ################################################
118 .B # This is an example smartd startup config file
119 .B # /usr/local/etc/smartd.conf for monitoring three
120 .B # ATA disks, three SCSI disks, six ATA disks
121 .B # behind two 3ware controllers and one SATA disk
124 .B # First ATA disk on two different interfaces. On
125 .B # the second disk, start a long self-test every
126 .B # Sunday between 3 and 4 am.
128 .B \ \ /dev/hda -a -m admin@example.com,root@localhost
129 .B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03
132 .B # SCSI disks. Send a TEST warning email to admin on
136 .B \ \ /dev/sdb -m admin@example.com -M test
139 .B # Strange device. It\'s SCSI. Start a scheduled
140 .B # long self test between 5 and 6 am Monday/Thursday
141 .B \ \ /dev/weird -d scsi -s L/../../(1|4)/05
144 .B # Linux-specific: SATA disk using the libata
145 .B # driver. This requires a 2.6.15 or greater
146 .B # kernel. The device entry is SCSI but the
147 .B # underlying disk understands ATA SMART commands
148 .B \ \ /dev/sda -a -d ata
151 .B # Four ATA disks on a 3ware 6/7/8000 controller.
152 .B # Start short self-tests daily between midnight and 1am,
153 .B # 1-2, 2-3, and 3-4 am. Starting with the Linux 2.6
154 .B # kernel series, /dev/sdX is deprecated in favor of
155 .B # /dev/tweN. For example replace /dev/sdc by /dev/twe0
156 .B # and /dev/sdd by /dev/twe1.
157 .B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00
158 .B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01
159 .B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02
160 .B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03
163 .B # Two ATA disks on a 3ware 9000 controller.
164 .B # Start long self-tests Sundays between midnight and
166 .B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00
167 .B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02
170 .B # The following line enables monitoring of the
171 .B # ATA Error Log and the Self-Test Error Log.
172 .B # It also tracks changes in both Prefailure
173 .B # and Usage Attributes, apart from Attributes
174 .B # 9, 194, and 231, and shows continued lines:
176 .B \ \ /dev/hdd\ -l\ error\ \e
177 .B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e
178 .B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked:
179 .B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature
180 .B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature
181 .B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours
183 .B ################################################
187 .SH CONFIGURATION FILE DIRECTIVES
190 If the first non-comment entry in the configuration file is the text
193 in capital letters, then
195 will ignore any remaining lines in the configuration file, and will
198 may optionally be followed by Directives that will apply to all
199 devices that are found in the scan. Please see below for additional
203 The following are the Directives that may appear following the device
207 .B /usr/local/etc/smartd.conf
208 configuration file. Note that
209 .B these are NOT command-line options for
211 The Directives below may appear in any order, following the device
214 .B For an ATA device,
215 if no Directives appear, then the device will be monitored
216 as if the \'\-a\' Directive (monitor all SMART properties) had been given.
218 .B If a SCSI disk is listed,
219 it will be monitored at the maximum implemented level: roughly
220 equivalent to using the \'\-H \-l selftest\' options for an ATA disk.
221 So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and
222 \'\-M\', the Directives below are ignored for SCSI disks. For SCSI
223 disks, the \'\-m\' Directive sends a warning email if the SMART status
224 indicates a disk failure or problem, if the SCSI inquiry about disk
225 status fails, or if new errors appear in the self-test log.
227 .B If a 3ware controller is used
228 then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?
229 or /dev/twa?) must be listed, along with the \'\-d 3ware,N\' Directive
230 (see below). The individual ATA disks hosted by the 3ware controller
231 appear to \fBsmartd\fP as normal ATA devices. Hence all the ATA
232 directives can be used for these disks (but see note below).
236 Specifies the type of the device. This Directive may be used multiple
237 times for one device, but the arguments \fIata\fP, \fIscsi\fP,
238 \fImarvell\fP, and \fI3ware,N\fP are mutually-exclusive. If more than
239 one is given then \fBsmartd\fP will use the last one which appears.
241 If none of these three arguments is given, then \fBsmartd\fP will
242 first attempt to guess the device type by looking at whether the sixth
243 character in the device name is an \'s\' or an \'h\'. This will work for
244 device names like /dev/hda or /dev/sdb, and corresponds to choosing
245 \fIata\fP or \fIscsi\fP respectively. If
247 can\'t guess from this sixth character, then it will simply try to
248 access the device using first ATA and then SCSI ioctl()s.
250 The valid arguments to this Directive are:
253 \- the device type is ATA. This prevents
255 from issuing SCSI commands to an ATA device.
258 \- the device type is SCSI. This prevents
260 from issuing ATA commands to a SCSI device.
263 \- Under Linux, interact with SATA disks behind Marvell chip-set
264 controllers (using the Marvell rather than libata driver).
267 \- the device consists of one or more ATA disks connected to a 3ware
268 RAID controller. The non-negative integer N (in the range from 0 to 15
269 inclusive) denotes which disk on the controller is monitored. In log
270 files and email messages this disk will be identified as 3ware_disk_XX
271 with XX in the range from 00 to 15 inclusive.
273 This Directive may at first appear confusing, because the 3ware
274 controller is a SCSI device (such as /dev/sda) and should be listed as
275 such in the the configuration file.
276 However when the \'\-d 3ware,N\'
277 Directive is used, then the corresponding disk is addressed using
278 native ATA commands which are \'passed through\' the SCSI driver. All
279 ATA Directives listed in this man page may be used. Note that while
280 you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to
281 address \fBany\fP of the physical disks (3ware ports), error and log
282 messages will make the most sense if you always list the 3ware SCSI
283 logical device corresponding to the particular physical disks. Please
284 see the \fBsmartctl\fP man page for further details.
286 ATA disks behind 3ware controllers may alternatively be accessed via a
287 character device interface /dev/twe0-15 (3ware 6000/7000/8000
288 controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note
289 that the 9000 series controllers may \fBonly\fP be accessed using the
290 character device interface /dev/twa0-15 and not the SCSI device
291 interface /dev/sd?. Please see the \fBsmartctl\fP man page for
294 Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'
295 (\fB-S on\fP) and \'Enable Automatic Offline\' (\fB-o on\fP) commands
296 to the disk, if the SCSI interface is used, and produce these types of
297 harmless syslog error messages instead: \fB\'3w-xxxx: tw_ioctl():
298 Passthru size (123392) too big\'\fP. This can be fixed by upgrading to
299 version 1.02.00.037 or later of the 3w-xxxx driver, or by applying a
300 patch to older versions. See
301 \fBhttp://smartmontools.sourceforge.net/\fP for instructions.
302 Alternatively use the character device interfaces /dev/twe0-15 (3ware
303 6/7/8000 series controllers) or /dev/twa0-15 (3ware 9000 series
307 .B 3ware controllers are currently ONLY supported under Linux.
310 \- the device or its media is removable. This indicates to
312 that it should continue (instead of exiting, which is the default
313 behavior) if the device does not appear to be present when
314 \fBsmartd\fP is started. This Directive may be used in conjunction
315 with the other \'\-d\' Directives.
319 This \'nocheck\' Directive is used to prevent a disk from being
320 spun-up when it is periodically polled by \fBsmartd\fP.
322 ATA disks have five different power states. In order of increasing
323 power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',
324 and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the
325 disk\'s platters are not spinning. But usually, in response to SMART
326 commands issued by \fBsmartd\fP, the disk platters are spun up. So if
327 this option is not used, then a disk which is in a low\-power mode may
328 be spun up and put into a higher\-power mode when it is periodically
329 polled by \fBsmartd\fP.
331 Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,
332 then it won't respond to \fBsmartd\fP commands, and so the disk won't
333 be registered as a device for \fBsmartd\fP to monitor. If a disk is in
334 any other low\-power mode, then the commands issued by \fBsmartd\fP to
335 register the disk will probably cause it to spin\-up.
337 The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s
338 periodic checks should still be carried out when the device is in a
339 low\-power mode. It may be used to prevent a disk from being spun\-up
340 by periodic \fBsmartd\fP polling. The allowed values of POWERMODE
344 \- \fBsmartd\fP will poll (check) the device regardless of its power
345 mode. This may cause a disk which is spun\-down to be spun\-up when
346 \fBsmartd\fP checks it. This is the default behavior if the '\-n'
347 Directive is not given.
350 \- check the device unless it is in SLEEP mode.
353 \- check the device unless it is in SLEEP or STANDBY mode. In
354 these modes most disks are not spinning, so if you want to prevent
355 a laptop disk from spinning up each time that \fBsmartd\fP polls,
356 this is probably what you want.
359 \- check the device unless it is in SLEEP, STANDBY or IDLE mode.
360 In the IDLE state, most disks are still spinning, so this is probably
363 When a periodic test is skipped, \fBsmartd\fP normally writes an
364 informal log message. The message can be suppressed by appending
365 the option \',q\' to POWERMODE (like \'\-n standby,q\').
366 This prevents a laptop disk from spinning up due to this message.
370 Specifies how tolerant
372 should be of SMART command failures. The valid arguments to this
376 \- do not try to monitor the disk if a mandatory SMART command fails, but
377 continue if an optional SMART command fails. This is the default.
380 \- try to monitor the disk even if it appears to lack SMART
381 capabilities. This may be required for some old disks (prior to
382 ATA\-3 revision 4) that implemented SMART before the SMART standards
383 were incorporated into the ATA/ATAPI Specifications. This may also be
384 needed for some Maxtor disks which fail to comply with the ATA
385 Specifications and don't properly indicate support for error\- or
388 [Please see the \fBsmartctl \-T\fP command-line option.]
391 Enables or disables SMART Automatic Offline Testing when
393 starts up and has no further effect. The valid arguments to this
394 Directive are \fIon\fP and \fIoff\fP.
396 The delay between tests is vendor-specific, but is typically four
399 Note that SMART Automatic Offline Testing is \fBnot\fP part of the ATA
400 Specification. Please see the
402 command-line option documentation for further information about this
406 Enables or disables Attribute Autosave when \fBsmartd\fP
407 starts up and has no further effect. The valid arguments to this
408 Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices.
409 [Please see the \fBsmartctl \-S\fP command-line option.]
412 Check the SMART health status of the disk. If any Prefailure
413 Attributes are less than or equal to their threshold values, then disk
414 failure is predicted in less than 24 hours, and a message at loglevel
416 will be logged to syslog. [Please see the
418 command-line option.]
421 Reports increases in the number of errors in one of the two SMART logs. The
422 valid arguments to this Directive are:
425 \- report if the number of ATA errors reported in the ATA Error Log
426 has increased since the last check.
429 \- report if the number of failed tests reported in the SMART
430 Self-Test Log has increased since the last check, or if the timestamp
431 associated with the most recent failed test has increased. Note that
432 such errors will \fBonly\fP be logged if you run self-tests on the
433 disk (and it fails a test!). Self-Tests can be run automatically by
434 \fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below.
435 Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP
436 and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of
437 the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP
438 command-line option.]
440 [Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line
444 Run Self-Tests or Offline Immediate Tests, at scheduled times. A
445 Self- or Offline Immediate Test will be run at the end of periodic
446 device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP
447 match the extended regular expression \fBREGEXP\fP. Here:
450 is the type of the test. The values that \fBsmartd\fP will try to
451 match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a
452 \fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA
453 only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As
454 soon as a match is found, the test will be started and no additional
455 matches will be sought for that device and that polling cycle.
457 is the month of the year, expressed with two decimal digits. The
458 range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP
459 use a single decimal digit or the match will always fail!
461 is the day of the month, expressed with two decimal digits. The
462 range is from 01 to 31 inclusive. Do \fBnot\fP
463 use a single decimal digit or the match will always fail!
465 is the day of the week, expressed with one decimal digit. The
466 range is from 1 (Monday) to 7 (Sunday) inclusive.
468 is the hour of the day, written with two decimal digits, and given in
469 hours after midnight. The range is 00 (midnight to just before 1am)
470 to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a
471 single decimal digit or the match will always fail!
473 .\" The following two lines are a workaround for a man2html bug. Please leave them.
474 .\" They define a non-existent option; useful because man2html can't correctly reset the margins.
477 Some examples follow. In reading these, keep in mind that in extended
478 regular expressions a dot \fB\'.\'\fP matches any single character, and
479 a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP,
482 To schedule a short Self-Test between 2-3am every morning, use:
484 \fB \-s S/../.././02\fP
486 To schedule a long Self-Test between 4-5am every Sunday morning, use:
488 \fB \-s L/../../7/04\fP
490 To schedule a long Self-Test between 10-11pm on the first and
491 fifteenth day of each month, use:
493 \fB \-s L/../(01|15)/./22\fP
495 To schedule an Offline Immediate test after every midnight, 6am,
496 noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long
497 Self-Test every Saturday at 3-4am, use:
499 \fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP
502 Scheduled tests are run immediately following the regularly-scheduled
503 device polling, if the current local date, time, and test type, match
504 \fBREGEXP\fP. By default the regularly-scheduled device polling
505 occurs every thirty minutes after starting \fBsmartd\fP. Take caution
506 if you use the \'\-i\' option to make this polling interval more than
507 sixty minutes: the poll times may fail to coincide with any of the
508 testing times that you have specified with \fBREGEXP\fP, and so the
509 self tests may not take place as you wish.
511 Before running an offline or self-test, \fBsmartd\fP checks to be sure
512 that a self-test is not already running. If a self-test \fBis\fP
513 already running, then this running self test will \fBnot\fP be
514 interrupted to begin another test.
516 \fBsmartd\fP will not attempt to run \fBany\fP type of test if another
517 test was already started or run in the same hour.
519 Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG.
520 You can use these or the '-q showtests' command-line option to verify
521 that you constructed \fBREGEXP\fP correctly. The matching order
522 (\fBL\fP before \fBS\fP before \fBC\fP before \fBO\fP) ensures that
523 if multiple test types are all scheduled for the same hour, the
524 longer test type has precedence. This is usually the desired behavior.
526 Unix users: please beware that the rules for extended regular
527 expressions [regex(7)] are \fBnot\fP the same as the rules for
528 file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will
529 issue harmless informational warning messages if it detects characters
530 in \fBREGEXP\fP that appear to indicate that you have made this
535 Send a warning email to the email address \fBADD\fP if the \'\-H\',
536 \'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a
537 new error, or if a SMART command to the disk fails. This Directive
538 only works in conjunction with these other Directives (or with the
539 equivalent default \'\-a\' Directive).
541 To prevent your email in-box from getting filled up with warning
542 messages, by default only a single warning will be sent for each of
543 the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or
544 \'\-O\' even if more than one failure or error is detected or if the
545 failure or error persists. [This behavior can be modified; see the
546 \'\-M\' Directive below.]
548 To send email to more than one user, please use the following "comma
549 separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP
552 To test that email is being sent correctly, use the \'\-M test\'
553 Directive described below to send one test email message on
557 By default, email is sent using the system
559 command. In order that
561 find the mail command (normally /bin/mail) an executable named
563 must be in the path of the shell or environment from which
565 was started. If you wish to specify an explicit path to the mail
566 executable (for example /usr/local/bin/mail) or a custom script to
567 run, please use the \'\-M exec\' Directive below.
569 Note that by default under Solaris, in the previous paragraph,
570 \'\fBmailx\fP\' and \'\fB/bin/mailx\fP\' are used, since Solaris
571 \'/bin/mail\' does not accept a \'\-s\' (Subject) command-line
574 On Windows, the \'\fBBlat\fP\' mailer
575 (\fBhttp://blat.sourceforge.net/\fP) is used by default.
576 This mailer uses a different command line syntax, see
579 Note also that there is a special argument
581 which can be given to the \'\-m\' Directive in conjunction with the \'\-M
582 exec\' Directive. Please see below for an explanation of its effect.
584 If the mailer or the shell running it produces any STDERR/STDOUT
585 output, then a snippet of that output will be copied to SYSLOG. The
586 remainder of the output is discarded. If problems are encountered in
587 sending mail, this should help you to understand and fix them. If
588 you have mail problems, we recommend running \fBsmartd\fP in debug
589 mode with the \'-d\' flag, using the \'-M test\' Directive described
592 The following extension is available on Windows:
593 By specifying \'\fBmsgbox\fP\' as a mail address, a warning
594 "email" is displayed as a message box on the screen.
595 Using both \'\fBmsgbox\fP\' and regular mail addresses is possible,
596 if \'\fBmsgbox\fP\' is the first word in the comma separated list.
597 With \'\fBsysmsgbox\fP\', a system modal (always on top) message box
598 is used. If running as a service, a service notification message box
599 (always shown on current visible desktop) is used.
603 These Directives modify the behavior of the
605 email warnings enabled with the \'\-m\' email Directive described above.
606 These \'\-M\' Directives only work in conjunction with the \'\-m\'
607 Directive and can not be used without it.
609 Multiple \-M Directives may be given. If more than one of the
610 following three \-M Directives are given (example: \-M once \-M daily)
611 then the final one (in the example, \-M daily) is used.
613 The valid arguments to the \-M Directive are (one of the following
617 \- send only one warning email for each type of disk problem detected. This
621 \- send additional warning reminder emails, once per day, for each type
622 of disk problem detected.
625 \- send additional warning reminder emails, after a one-day interval,
626 then a two-day interval, then a four-day interval, and so on for each
627 type of disk problem detected. Each interval is twice as long as the
630 In addition, one may add zero or more of the following Directives:
633 \- send a single test email
636 startup. This allows one to verify that email is delivered correctly.
639 \- run the executable PATH instead of the default mail command, when
641 needs to send email. PATH must point to an executable binary file or
644 By setting PATH to point to a customized script, you can make
645 \fBsmartd\fP perform useful tricks when a disk problem is detected
646 (beeping the console, shutting down the machine, broadcasting warnings
647 to all logged-in users, etc.) But please be careful. \fBsmartd\fP
648 will \fBblock\fP until the executable PATH returns, so if your
649 executable hangs, then \fBsmartd\fP will also hang. Some sample
650 scripts are included in
651 /usr/local/share/doc/smartmontools-5.1/examplescripts/.
653 The return status of the executable is recorded by \fBsmartd\fP in
654 SYSLOG. The executable is not expected to write to STDOUT or
655 STDERR. If it does, then this is interpreted as indicating that
656 something is going wrong with your executable, and a fragment of this
657 output is logged to SYSLOG to help you to understand the problem.
658 Normally, if you wish to leave some record behind, the executable
659 should send mail or write to a file or device.
661 Before running the executable, \fBsmartd\fP sets a number of
662 environment variables. These environment variables may be used to
663 control the executable\'s behavior. The environment variables
664 exported by \fBsmartd\fP are:
666 .IP \fBSMARTD_MAILER\fP 4
667 is set to the argument of \-M exec, if present or else to \'mail\'
668 (examples: /bin/mail, mail).
669 .IP \fBSMARTD_DEVICE\fP 4
670 is set to the device path (examples: /dev/hda, /dev/sdb).
671 .IP \fBSMARTD_DEVICETYPE\fP 4
672 is set to the device type (possible values: ata, scsi, 3ware,N). Here
673 N=0,...,15 denotes the ATA disk behind a 3ware RAID controller.
674 .IP \fBSMARTD_DEVICESTRING\fP 4
675 is set to the device description. For SMARTD_DEVICETYPE of ata or
676 scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers,
677 the form used is \'/dev/sdc [3ware_disk_01]\'. In this case the device
678 string contains a space and is NOT quoted. So to use
679 $SMARTD_DEVICESTRING in a bash script you should probably enclose it
681 .IP \fBSMARTD_FAILTYPE\fP 4
682 gives the reason for the warning or message email. The possible values that
683 it takes and their meanings are:
686 \fIEmailTest\fP: this is an email test message.
689 \fIHealth\fP: the SMART health status indicates imminent failure.
692 \fIUsage\fP: a usage Attribute has failed.
695 \fISelfTest\fP: the number of self-test failures has increased.
698 \fIErrorCount\fP: the number of errors in the ATA error log has increased.
701 \fICurrentPendingSector\fP: one of more disk sectors could not be
702 read and are marked to be reallocated (replaced with spare sectors).
705 \fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing,
706 one or more disk sectors could not be read.
709 \fIFailedHealthCheck\fP: the SMART health status command failed.
712 \fIFailedReadSmartData\fP: the command to read SMART Attribute data failed.
715 \fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed.
718 \fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed.
721 \fIFailedOpenDevice\fP: the open() command to the device failed.
722 .IP \fBSMARTD_ADDRESS\fP 4
723 is determined by the address argument ADD of the \'\-m\' Directive.
724 If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set.
725 Otherwise, it is set to the comma-separated-list of email addresses
726 given by the argument ADD, with the commas replaced by spaces
727 (example:admin@example.com root). If more than one email address is
728 given, then this string will contain space characters and is NOT
729 quoted, so to use it in a bash script you may want to enclose it in
731 .IP \fBSMARTD_MESSAGE\fP 4
732 is set to the one sentence summary warning email message string from
734 This message string contains space characters and is NOT quoted. So to
735 use $SMARTD_MESSAGE in a bash script you should probably enclose it in
737 .IP \fBSMARTD_FULLMESSAGE\fP 4
738 is set to the contents of the entire email warning message string from
740 This message string contains space and return characters and is NOT quoted. So to
741 use $SMARTD_FULLMESSAGE in a bash script you should probably enclose it in
743 .IP \fBSMARTD_TFIRST\fP 4
744 is a text string giving the time and date at which the first problem
745 of this type was reported. This text string contains space characters
746 and no newlines, and is NOT quoted. For example:
749 Sun Feb 9 14:58:19 2003 CST
750 .IP \fBSMARTD_TFIRSTEPOCH\fP 4
751 is an integer, which is the unix epoch (number of seconds since Jan 1,
752 1970) for \fBSMARTD_TFIRST\fP.
754 .\" The following two lines are a workaround for a man2html bug. Please leave them.
755 .\" They define a non-existent option; useful because man2html can't correctly reset the margins.
758 The shell which is used to run PATH is system-dependent. For vanilla
759 Linux/glibc it\'s bash. For other systems, the man page for
760 \fBpopen\fP(3) should say what shell is used.
762 If the \'\-m ADD\' Directive is given with a normal address argument,
763 then the executable pointed to by PATH will be run in a shell with
764 STDIN receiving the body of the email message, and with the same
765 command-line arguments:
767 -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS
769 that would normally be provided to \'mail\'. Examples include:
771 .B -m user@home -M exec /bin/mail
772 .B -m admin@work -M exec /usr/local/bin/mailto
773 .B -m root -M exec /Example_1/bash/script/below
776 Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is
779 - -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS"
782 If the \'\-m ADD\' Directive is given with the special address argument
784 then the executable pointed to by PATH is run in a shell with
788 command-line arguments, for example:
790 .B -m <nomailer> -M exec /Example_2/bash/script/below
792 If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP
793 assumes that something is going wrong, and a snippet of that output
794 will be copied to SYSLOG. The remainder of the output is then
797 Some EXAMPLES of scripts that can be used with the \'\-M exec\'
798 Directive are given below. Some sample scripts are also included in
799 /usr/local/share/doc/smartmontools-5.1/examplescripts/.
803 Check for \'failure\' of any Usage Attributes. If these Attributes are
804 less than or equal to the threshold, it does NOT indicate imminent
805 disk failure. It "indicates an advisory condition where the usage or
806 age of the device has exceeded its intended design life period."
807 [Please see the \fBsmartctl \-A\fP command-line option.]
810 Report anytime that a Prefail Attribute has changed
811 its value since the last check, 30 minutes ago. [Please see the
813 command-line option.]
816 Report anytime that a Usage Attribute has changed its value
817 since the last check, 30 minutes ago. [Please see the
819 command-line option.]
822 Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
823 Tracks changes in \fIall\fP device Attributes (both Prefailure and
824 Usage). [Please see the \fBsmartctl\fP \-A command-line option.]
827 Ignore device Attribute number \fBID\fP when checking for failure of
828 Usage Attributes. \fBID\fP must be a decimal integer in the range
829 from 1 to 255. This Directive modifies the behavior of the \'\-f\'
830 Directive and has no effect without it.
832 This is useful, for example, if you have a very old disk and don\'t
833 want to keep getting messages about the hours-on-lifetime Attribute
834 (usually Attribute 9) failing. This Directive may appear multiple
835 times for a single device, if you want to ignore multiple Attributes.
838 Ignore device Attribute \fBID\fP when tracking changes in the
839 Attribute values. \fBID\fP must be a decimal integer in the range
840 from 1 to 255. This Directive modifies the behavior of the \'\-p\',
841 \'\-u\', and \'\-t\' tracking Directives and has no effect without one
844 This is useful, for example, if one of the device Attributes is the disk
845 temperature (usually Attribute 194 or 231). It\'s annoying to get reports
846 each time the temperature changes. This Directive may appear multiple
847 times for a single device, if you want to ignore multiple Attributes.
850 When tracking, report the \fIRaw\fP value of Attribute \fBID\fP along
851 with its (normally reported) \fINormalized\fP value. \fBID\fP must be
852 a decimal integer in the range from 1 to 255. This Directive modifies
853 the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives
854 and has no effect without one of them. This Directive may be given
857 A common use of this Directive is to track the device Temperature
858 (often ID=194 or 231).
862 When tracking, report whenever the \fIRaw\fP value of Attribute
863 \fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes
864 of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal
865 integer in the range from 1 to 255. This Directive modifies the
866 behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and
867 has no effect without one of them. This Directive may be given
870 If this Directive is given, it automatically implies the \'\-r\'
871 Directive for the same Attribute, so that the Raw value of the
872 Attribute is reported.
874 A common use of this Directive is to track the device Temperature
875 (often ID=194 or 231). It is also useful for understanding how
876 different types of system behavior affects the values of certain
881 [ATA only] Report if the current number of pending sectors is
882 non-zero. Here \fBID\fP is the id number of the Attribute whose raw
883 value is the Current Pending Sector count. The allowed range of
884 \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
885 ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to
886 \fB\-C 197\fP (since Attribute 197 is generally used to monitor
889 A pending sector is a disk sector (containing 512 bytes of your data)
890 which the device would like to mark as ``bad" and reallocate.
891 Typically this is because your computer tried to read that sector, and
892 the read failed because the data on it has been corrupted and has
893 inconsistent Error Checking and Correction (ECC) codes. This is
894 important to know, because it means that there is some unreadable data
895 on the disk. The problem of figuring out what file this data belongs
896 to is operating system and file system specific. You can typically
897 force the sector to reallocate by writing to it (translation: make the
898 device substitute a spare good sector for the bad one) but at the
899 price of losing the 512 bytes of data stored there.
903 [ATA only] Report if the number of offline uncorrectable sectors is
904 non-zero. Here \fBID\fP is the id number of the Attribute whose raw
905 value is the Offline Uncorrectable Sector count. The allowed range of
906 \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
907 ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to
908 \fB\-U 198\fP (since Attribute 198 is generally used to monitor
909 offline uncorrectable sectors).
912 An offline uncorrectable sector is a disk sector which was not
913 readable during an off\-line scan or a self\-test. This is important
914 to know, because if you have data stored in this disk sector, and you
915 need to read it, the read will fail. Please see the previous \'\-C\'
916 option for more details.
920 [ATA only] Modifies the behavior of \fBsmartd\fP to compensate for
921 some known and understood device firmware bug. The arguments to this
922 Directive are exclusive, so that only the final Directive given is
923 used. The valid values are:
926 \- Assume that the device firmware obeys the ATA specifications. This is
927 the default, unless the device has presets for \'\-F\' in the device
931 \- In some Samsung disks (example: model SV4012H Firmware Version:
932 RM100-08) some of the two- and four-byte quantities in the SMART data
933 structures are byte-swapped (relative to the ATA specification).
934 Enabling this option tells \fBsmartd\fP to evaluate these quantities
935 in byte-reversed order. Some signs that your disk needs this option
936 are (1) no self-test log printed, even though you have run self-tests;
937 (2) very large numbers of ATA errors reported in the ATA error log;
938 (3) strange and impossible values for the ATA error log timestamps.
941 \- In more recent Samsung disks (firmware revisions ending in "\-23") the
942 number of ATA errors reported is byte swapped. Enabling this option
943 tells \fBsmartd\fP to evaluate this quantity in byte-reversed order.
945 Note that an explicit \'\-F\' Directive will over-ride any preset
946 values for \'\-F\' (see the \'\-P\' option below).
949 [Please see the \fBsmartctl \-F\fP command-line option.]
953 Modifies the labeling for Attribute N, for disks which use
954 non-standard Attribute definitions. This is useful in connection with
955 the Attribute tracking/reporting Directives.
957 This Directive may appear multiple times. Valid arguments to this
961 \- Raw Attribute number 9 is power-on time in minutes. Its raw value
962 will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
963 minutes in the range 0-59 inclusive. Y is always printed with two
964 digits, for example \'06\' or \'31\' or \'00\'.
967 \- Raw Attribute number 9 is power-on time in seconds. Its raw value
968 will be displayed in the form \'Xh+Ym+Zs\'. Here X is hours, Y is
969 minutes in the range 0-59 inclusive, and Z is seconds in the range
970 0-59 inclusive. Y and Z are always printed with two digits, for
971 example \'06\' or \'31\' or \'00\'.
974 \- Raw Attribute number 9 is power-on time, measured in units of 30
975 seconds. This format is used by some Samsung disks. Its raw value
976 will be displayed in the form \'Xh+Ym\'. Here X is hours, and Y is
977 minutes in the range 0-59 inclusive. Y is always printed with two
978 digits, for example \'06\' or \'31\' or \'00\'.
981 \- Raw Attribute number 9 is the disk temperature in Celsius.
983 .I 192,emergencyretractcyclect
984 \- Raw Attribute number 192 is the Emergency Retract Cycle Count.
987 \- Raw Attribute number 193 contains two values. The first is the
988 number of load cycles. The second is the number of unload cycles.
989 The difference between these two values is the number of times that
990 the drive was unexpectedly powered off (also called an emergency
991 unload). As a rule of thumb, the mechanical stress created by one
992 emergency unload is equivalent to that created by one hundred normal
996 \- Raw Attribute number 194 is ten times the disk temperature in
997 Celsius. This is used by some Samsung disks (example: model SV1204H
998 with RK100-13 firmware).
1001 \- Raw Attribute number 194 is NOT the disk temperature, and its
1002 interpretation is unknown. This is primarily useful for the -P
1003 (presets) Directive.
1005 .I 198,offlinescanuncsectorct
1006 \- Raw Attribute number 198 is the Offline Scan UNC Sector Count.
1008 .I 200,writeerrorcount
1009 \- Raw Attribute number 200 is the Write Error Count.
1011 .I 201,detectedtacount
1012 \- Raw Attribute number 201 is the Detected TA Count.
1015 \- Raw Attribute number 220 is the disk temperature in Celsius.
1017 Note: a table of hard drive models, listing which Attribute
1018 corresponds to temperature, can be found at:
1019 \fBhttp://www.guzu.net/linux/hddtemp.db\fP
1022 \- Print the Raw value of Attribute N as six 8-bit unsigned base-10
1023 integers. This may be useful for decoding the meaning of the Raw
1024 value. The form \'N,raw8\' prints Raw values for ALL Attributes in this
1025 form. The form (for example) \'123,raw8\' only prints the Raw value for
1026 Attribute 123 in this form.
1029 \- Print the Raw value of Attribute N as three 16-bit unsigned base-10
1030 integers. This may be useful for decoding the meaning of the Raw
1031 value. The form \'N,raw16\' prints Raw values for ALL Attributes in this
1032 form. The form (for example) \'123,raw16\' only prints the Raw value for
1033 Attribute 123 in this form.
1036 \- Print the Raw value of Attribute N as a 48-bit unsigned base-10
1037 integer. This may be useful for decoding the meaning of the Raw
1038 value. The form \'N,raw48\' prints Raw values for ALL Attributes in
1039 this form. The form (for example) \'123,raw48\' only prints the Raw
1040 value for Attribute 123 in this form.
1046 should use any preset options that are available for this drive. The
1047 valid arguments to this Directive are:
1050 \- use any presets that are available for this drive. This is the default.
1053 \- do not use any presets for this drive.
1056 \- show the presets listed for this drive in the database.
1059 \- show the presets that are available for all drives and then exit.
1063 command-line option.]
1067 Equivalent to turning on all of the following Directives:
1069 to check the SMART health status,
1071 to report failures of Usage (rather than Prefail) Attributes,
1073 to track changes in both Prefailure and Usage Attributes,
1074 .B \'\-l\ selftest\'
1075 to report increases in the number of Self-Test Log errors,
1077 to report increases in the number of ATA errors,
1079 to report nonzero values of the current pending sector count, and
1081 to report nonzero values of the offline pending sector count.
1083 Note that \-a is the default for ATA devices. If none of these other
1084 Directives is given, then \-a is assumed.
1088 Comment: ignore the remainder of the line.
1091 Continuation character: if this is the last non-white or non-comment
1092 character on a line, then the following line is a continuation of the current
1095 If you are not sure which Directives to use, I suggest experimenting
1096 for a few minutes with
1098 to see what SMART functionality your disk(s) support(s). If you do
1099 not like voluminous syslog messages, a good choice of
1101 configuration file Directives might be:
1103 .B \-H \-l\ selftest \-l\ error \-f.
1105 If you want more frequent information, use:
1109 .B ADDITIONAL DETAILS ABOUT DEVICESCAN
1110 If the first non-comment entry in the configuration file is the text
1111 string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will
1112 ignore any remaining lines in the configuration file, and will scan
1115 If \fBDEVICESCAN\fP is not followed by any Directives, then smartd
1116 will scan for both ATA and SCSI devices, and will monitor all possible
1117 SMART properties of any devices that are found.
1119 \fBDEVICESCAN\fP may optionally be followed by any valid Directives,
1120 which will be applied to all devices that are found in the scan. For
1123 .B DEVICESCAN -m root@example.com
1125 will scan for all devices, and then monitor them. It will send one
1126 email warning per device for any problems that are found.
1128 .B DEVICESCAN -d ata -m root@example.com
1130 will do the same, but restricts the scan to ATA devices only.
1132 .B DEVICESCAN -H -d ata -m root@example.com
1134 will do the same, but only monitors the SMART health status of the
1135 devices, (rather than the default \-a, which monitors all SMART
1139 .B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\'
1140 These are two examples of shell scripts that can be used with the \'\-M
1141 exec PATH\' Directive described previously. The paths to these scripts
1142 and similar executables is the PATH argument to the \'\-M exec PATH\'
1145 Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'. It appends
1148 to the output of the smartd email warning message and sends it to ADDRESS.
1154 # Save the email message (STDIN) to a file:
1157 # Append the output of smartctl -a to the message:
1158 /usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
1160 # Now email the message to the user at address ADD:
1161 /bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
1165 Example 2: This script is for use with \'\-m <nomailer> \-M exec
1166 PATH\'. It warns all users about a disk problem, waits 30 seconds, and
1167 then powers down the machine.
1173 # Warn all users of a problem
1174 wall \'Problem detected with disk: \' "$SMARTD_DEVICESTRING"
1175 wall \'Warning message from smartd is: \' "$SMARTD_MESSAGE"
1176 wall \'Shutting down machine in 30 seconds... \'
1178 # Wait half a minute
1181 # Power down the machine
1182 /sbin/shutdown -hf now
1186 Some example scripts are distributed with the smartmontools package,
1187 in /usr/local/share/doc/smartmontools-5.1/examplescripts/.
1189 Please note that these scripts typically run as root, so any files
1190 that they read/write should not be writable by ordinary users or
1191 reside in directories like /tmp that are writable by ordinary users
1192 and may expose your system to symlink attacks.
1194 As previously described, if the scripts write to STDOUT or STDERR,
1195 this is interpreted as indicating that there was an internal error
1196 within the script, and a snippet of STDOUT/STDERR is logged to SYSLOG.
1197 The remainder is flushed.
1200 .\" DO NOT MODIFY THIS OR PREVIOUS/NEXT LINES. THIS DEFINES THE
1201 .\" END OF THE INCLUDED SECTION FROM smartd.8.in
1205 \fBBruce Allen\fP smartmontools-support@lists.sourceforge.net
1207 University of Wisconsin \- Milwaukee Physics Department
1211 The following have made large contributions to smartmontools:
1213 \fBCasper Dik\fP (Solaris SCSI interface)
1214 \fBChristian Franke\fP (Windows interface and Cygwin package)
1215 \fBDouglas Gilbert\fP (SCSI subsystem)
1216 \fBGuido Guenther\fP (Autoconf/Automake packaging)
1217 \fBGeoffrey Keating\fP (Darwin ATA interface)
1218 \fBEduard Martinescu\fP (FreeBSD interface)
1219 \fBFr\*'ed\*'eric L. W. Meunier\fP (Web site and Mailing list)
1220 \fBKeiji Sawada\fP (Solaris ATA interface)
1221 \fBSergey Svishchev\fP (NetBSD interface)
1222 \fBDavid Snyder and Sergey Svishchev\fP (OpenBSD interface)
1223 \fBPhil Williams\fP (User interface and drive database)
1225 Many other individuals have made smaller contributions and corrections.
1230 This code was derived from the smartsuite package, written by Michael
1231 Cornwell, and from the previous ucsc smartsuite package. It extends
1232 these to cover ATA-5 disks. This code was originally developed as a
1233 Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory
1234 (now part of the Storage Systems Research Center), Jack Baskin School
1235 of Engineering, University of California, Santa
1236 Cruz. \fBhttp://ssrc.soe.ucsc.edu/\fP .
1238 HOME PAGE FOR SMARTMONTOOLS:
1240 Please see the following web site for updates, further documentation, bug
1241 reports and patches:
1244 http://smartmontools.sourceforge.net/
1248 \fBsmartd\fP(8), \fBsmartctl\fP(8), \fBsyslogd\fP(8),
1249 \fBsyslog.conf\fP(5), \fBbadblocks\fP(8), \fBide\-smart\fP(8), \fBregex\fP(7).
1252 CVS ID OF THIS PAGE:
1253 $Id: smartd.conf.5.in,v 1.73 2006/04/12 14:03:14 ballen4705 Exp $