2 Copyright (C) 2002-10 Bruce Allen <smartmontools-support@lists.sourceforge.net>
3 Copyright (C) 2004-14 Christian Franke <smartmontools-support@lists.sourceforge.net>
5 $Id: smartd.conf.5.in 3965 2014-07-20 14:46:41Z chrfranke $
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 You should have received a copy of the GNU General Public License
13 (for example COPYING); If not, see <http://www.gnu.org/licenses/>.
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/
21 .TH SMARTD.CONF 5 CURRENT_SVN_DATE CURRENT_SVN_VERSION CURRENT_SVN_DATE
23 \fBsmartd.conf\fP \- SMART Disk Monitoring Daemon Configuration File\fP
26 CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
30 .\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools.
31 .\"! It does not contain info specific to other platforms.]
34 \fB/usr/local/etc/smartd.conf\fP is the configuration file for the \fBsmartd\fP
37 If the configuration file \fB/usr/local/etc/smartd.conf\fP is present,
38 \fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the
39 background. If \fBsmartd\fP subsequently receives a \fBHUP\fP signal,
40 it will then re-read the configuration file. If \fBsmartd\fP is
41 running in debug mode, then an \fBINT\fP signal will also make it
42 re-read the configuration file. This signal can be generated by typing
43 \fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is
46 In the absence of a configuration file
47 \fBsmartd\fP will try to open all available devices
48 (see \fBsmartd\fP(8) man page).
49 A configuration file with a single line \fB\'DEVICESCAN \-a'\fP
50 would have the same effect.
52 This can be annoying if you have an ATA or SCSI device that hangs or
53 misbehaves when receiving SMART commands. Even if this causes no
54 problems, you may be annoyed by the string of error log messages about devices
55 that can\'t be opened.
57 One can avoid this problem, and gain more control over the types of
60 by using the configuration file
61 .B /usr/local/etc/smartd.conf.
62 This file contains a list of devices to monitor, with one device per
63 line. An example file is included with the
65 distribution. You will find this sample configuration file in
66 \fB/usr/local/share/doc/smartmontools/\fP. For security, the configuration file
67 should not be writable by anyone but root. The syntax of the file is as
70 There should be one device listed per line, although you may have
71 lines that are entirely comments or white space.
73 Any text following a hash sign \'#\' and up to the end of the line is
74 taken to be a comment, and ignored.
76 Lines may be continued by using a backslash \'\e\' as the last
77 non-whitespace or non-comment item on a line.
79 Note: a line whose first character is a hash sign \'#\' is treated as
80 a white-space blank line, \fBnot\fP as a non-existent line, and will
81 \fBend\fP a continuation line.
84 Here is an example configuration file. It\'s for illustrative purposes
85 only; please don\'t copy it onto your system without reading to the end
91 .B ################################################
92 .B # This is an example smartd startup config file
93 .B # /usr/local/etc/smartd.conf for monitoring three
94 .B # ATA disks, three SCSI disks, six ATA disks
95 .B # behind two 3ware controllers, three SATA disks
96 .B # directly connected to the HighPoint Rocket-
97 .B # RAID controller, two SATA disks connected to
98 .B # the HighPoint RocketRAID controller via a pmport
99 .B # device, four SATA disks connected to an Areca
100 .B # RAID controller, and one SATA disk.
102 .B # First ATA disk on two different interfaces. On
103 .B # the second disk, start a long self-test every
104 .B # Sunday between 3 and 4 am.
106 .B \ \ /dev/hda -a -m admin@example.com,root@localhost
107 .B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03
109 .B # SCSI disks. Send a TEST warning email to admin on
113 .B \ \ /dev/sdb -m admin@example.com -M test
115 .B # Strange device. It\'s SCSI. Start a scheduled
116 .B # long self test between 5 and 6 am Monday/Thursday
117 .B \ \ /dev/weird -d scsi -s L/../../(1|4)/05
119 .B # An ATA disk may appear as a SCSI device to the
120 .B # OS. If a SCSI to ATA Translation (SAT) layer
121 .B # is between the OS and the device then this can be
122 .B # flagged with the '-d sat' option. This situation
123 .B # may become common with SATA disks in SAS and FC
125 .B \ \ /dev/sda -a -d sat
128 .B # Three disks connected to a MegaRAID controller
129 .B # Start short self-tests daily between 1-2, 2-3, and
131 .B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01
132 .B \ \ /dev/sda -d megaraid,1 -a -s S/../.././02
133 .B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03
134 .B \ \ /dev/bus/0 -d megaraid,2 -a -s S/../.././03
136 .B # Three disks connected to an AacRaid controller
137 .B # Start short self-tests daily between 1-2, 2-3, and
139 .B \ \ /dev/sda -d aacraid,0,0,66 -a -s S/../.././01
140 .B \ \ /dev/sda -d aacraid,0,0,67 -a -s S/../.././02
141 .B \ \ /dev/sda -d aacraid,0,0,68 -a -s S/../.././03
144 .B # Four ATA disks on a 3ware 6/7/8000 controller.
145 .B # Start short self-tests daily between midnight and 1am,
146 .B # 1-2, 2-3, and 3-4 am. Starting with the Linux 2.6
147 .B # kernel series, /dev/sdX is deprecated in favor of
148 .B # /dev/tweN. For example replace /dev/sdc by /dev/twe0
149 .B # and /dev/sdd by /dev/twe1.
150 .B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00
151 .B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01
152 .B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02
153 .B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03
155 .B # Two ATA disks on a 3ware 9000 controller.
156 .B # Start long self-tests Sundays between midnight and
158 .B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00
159 .B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02
161 .B # Two SATA (not SAS) disks on a 3ware 9750 controller.
162 .B # Start long self-tests Sundays between midnight and
165 .B \ \ /dev/twl0 -d 3ware,0 -a -s L/../../7/00
166 .B \ \ /dev/twl0 -d 3ware,1 -a -s L/../../7/02
169 .B \ \ /dev/tws0 -d 3ware,0 -a -s L/../../7/00
170 .B \ \ /dev/tws0 -d 3ware,1 -a -s L/../../7/02
171 .\" %ENDIF OS FreeBSD
173 .B # Three SATA disks on a HighPoint RocketRAID controller.
174 .B # Start short self-tests daily between 1-2, 2-3, and
178 .B \ \ /dev/sde -d hpt,1/1 -a -s S/../.././01
179 .B \ \ /dev/sde -d hpt,1/2 -a -s S/../.././02
180 .B \ \ /dev/sde -d hpt,1/3 -a -s S/../.././03
184 .B /dev/hptrr -d hpt,1/1 -a -s S/../.././01
185 .B /dev/hptrr -d hpt,1/2 -a -s S/../.././02
186 .B /dev/hptrr -d hpt,1/3 -a -s S/../.././03
187 .\" %ENDIF OS FreeBSD
189 .B # Two SATA disks connected to a HighPoint RocketRAID
190 .B # via a pmport device. Start long self-tests Sundays
191 .B # between midnight and 1am and 2-3 am.
194 .B \ \ /dev/sde -d hpt,1/4/1 -a -s L/../../7/00
195 .B \ \ /dev/sde -d hpt,1/4/2 -a -s L/../../7/02
199 .B \ \ /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00
200 .B \ \ /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02
202 .\" %ENDIF OS FreeBSD
203 .B # Three SATA disks connected to an Areca
204 .B # RAID controller. Start long self-tests Sundays
205 .B # between midnight and 3 am.
207 .B \ \ /dev/sg2 -d areca,1 -a -s L/../../7/00
208 .B \ \ /dev/sg2 -d areca,2 -a -s L/../../7/01
209 .B \ \ /dev/sg2 -d areca,3 -a -s L/../../7/02
212 .B \ \ /dev/arcmsr0 -d areca,1 -a -s L/../../7/00
213 .B \ \ /dev/arcmsr0 -d areca,2 -a -s L/../../7/01
214 .B \ \ /dev/arcmsr0 -d areca,3 -a -s L/../../7/02
215 .\" %ENDIF OS FreeBSD
217 .B # The following line enables monitoring of the
218 .B # ATA Error Log and the Self-Test Error Log.
219 .B # It also tracks changes in both Prefailure
220 .B # and Usage Attributes, apart from Attributes
221 .B # 9, 194, and 231, and shows continued lines:
223 .B \ \ /dev/hdd\ -l\ error\ \e
224 .B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e
225 .B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked:
226 .B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature
227 .B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature
228 .B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours
230 .B ################################################
233 .SH CONFIGURATION FILE DIRECTIVES
234 If a non-comment entry in the configuration file is the text string
236 in capital letters, then
238 will ignore any remaining lines in the configuration file, and will
241 may optionally be followed by Directives that will apply to all
242 devices that are found in the scan. Please see below for additional
245 If an entry in the configuration file starts with
247 instead of a device name, then all directives in this entry are set
248 as defaults for the next device entries.
253 \ \ DEFAULT -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
257 \ \ DEFAULT -H -m admin@example.com
259 \ \ /dev/sde -d removable
262 has the same effect as:
265 \ \ /dev/sda -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
266 \ \ /dev/sdb -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
267 \ \ /dev/sdc -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
268 \ \ /dev/sdd -H -m admin@example.com
269 \ \ /dev/sde -d removable -H -m admin@example.com
273 The following are the Directives that may appear following the device
279 .B /usr/local/etc/smartd.conf
280 configuration file. Note that
281 .B these are NOT command-line options for
283 The Directives below may appear in any order, following the device
286 .B For an ATA device,
287 if no Directives appear, then the device will be monitored
288 as if the \'\-a\' Directive (monitor all SMART properties) had been given.
290 .B If a SCSI disk is listed,
291 it will be monitored at the maximum implemented level: roughly
292 equivalent to using the \'\-H \-l selftest\' options for an ATA disk.
293 So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and
294 \'\-M\', the Directives below are ignored for SCSI disks. For SCSI
295 disks, the \'\-m\' Directive sends a warning email if the SMART status
296 indicates a disk failure or problem, if the SCSI inquiry about disk
297 status fails, or if new errors appear in the self-test log.
299 .B If a 3ware controller is used
300 then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?,
301 /dev/twa?, /dev/twl? or /dev/tws?) must be listed, along with the \'\-d 3ware,N\'
302 Directive (see below). The individual ATA disks hosted by the 3ware
303 controller appear to \fBsmartd\fP as normal ATA devices. Hence all
304 the ATA directives can be used for these disks (but see note below).
306 .\" %IF OS Linux FreeBSD
307 .B If an Areca controller is used
308 then the corresponding device (SCSI /dev/sg? on Linux or /dev/arcmsr0 on
309 FreeBSD) must be listed, along with the \'\-d areca,N\' Directive (see below).
310 The individual SATA disks hosted by the Areca controller appear to \fBsmartd\fP
311 as normal ATA devices. Hence all the ATA directives can be used for
312 these disks. Areca firmware version 1.46 or later which supports
313 smartmontools must be used; Please see the \fBsmartctl\fP(8) man page
315 .\" %ENDIF OS Linux FreeBSD
318 Specifies the type of the device.
319 The valid arguments to this directive are:
322 \- attempt to guess the device type from the device name or from
323 controller type info provided by the operating system or from
324 a matching USB ID entry in the drive database.
328 \- the device type is ATA. This prevents
330 from issuing SCSI commands to an ATA device.
332 .\" %IF NOT OS Darwin
334 \- the device type is SCSI. This prevents
336 from issuing ATA commands to a SCSI device.
339 \- the device type is SCSI to ATA Translation (SAT).
340 This is for ATA disks that have a SCSI to ATA Translation (SAT) Layer
341 (SATL) between the disk and the operating system.
342 SAT defines two ATA PASS THROUGH SCSI commands, one 12 bytes long and
343 the other 16 bytes long. The default is the 16 byte variant which can be
344 overridden with either \'\-d sat,12\' or \'\-d sat,16\'.
346 If \'\-d sat,auto\' is specified, device type SAT (for ATA/SATA disks) is
347 only used if the SCSI INQUIRY data reports a SATL (VENDOR: "ATA ").
348 Otherwise device type SCSI (for SCSI/SAS disks) is used.
351 \- this device type is for ATA disks that are behind a Cypress USB to PATA
352 bridge. This will use the ATACB proprietary scsi pass through command.
353 The default SCSI operation code is 0x24, but although it can be overridden
354 with \'\-d usbcypress,0xN\', where N is the scsi operation code,
355 you're running the risk of damage to the device or filesystems on it.
357 .I usbjmicron[,p][,x][,PORT]
358 \- this device type is for SATA disks that are behind a JMicron USB to
359 PATA/SATA bridge. The 48-bit ATA commands (required e.g. for \'\-l xerror\',
360 see below) do not work with all of these bridges and are therefore disabled by
361 default. These commands can be enabled by \'\-d usbjmicron,x\'.
362 If two disks are connected to a bridge with two ports, an error message is printed
363 if no PORT is specified.
364 The port can be specified by \'\-d usbjmicron[,x],PORT\' where PORT is 0
365 (master) or 1 (slave). This is not necessary if the device uses a port
366 multiplier to connect multiple disks to one port. The disks appear under
367 separate /dev/ice names then.
368 CAUTION: Specifying \',x\' for a device which does not support it results
369 in I/O errors and may disconnect the drive. The same applies if the specified
370 PORT does not exist or is not connected to a disk.
372 [NEW EXPERIMENTAL SMARTD FEATURE]
373 The Prolific PL2507/3507 USB bridges with older firmware support a pass-through
374 command similar to JMicron and work with \'\-d usbjmicron,0\'.
375 Newer Prolific firmware requires a modified command which can be selected by
376 \'\-d usbjmicron,p\'.
377 Note that this does not yet support the SMART status command.
380 \- this device type is for SATA disks that are behind a SunplusIT USB to SATA
383 .\" %ENDIF NOT OS Darwin
386 \- [Linux only] interact with SATA disks behind Marvell chip-set
387 controllers (using the Marvell rather than libata driver).
390 \- [Linux only] the device consists of one or more SCSI/SAS disks connected
391 to a MegaRAID controller. The non-negative integer N (in the range of 0 to
392 127 inclusive) denotes which disk on the controller is monitored.
393 This interface will also work for Dell PERC controllers.
394 In log files and email messages this disk will be identified as
395 megaraid_disk_XXX with XXX in the range from 000 to 127 inclusive.
396 It is possible to set RAID device name as /dev/bus/N, where N is a SCSI bus
398 Please see the \fBsmartctl\fP(8) man page for further details.
401 \- [Linux only] [NEW EXPERIMENTAL SMARTD FEATURE]
402 the device consists of one or more SCSI/SAS disks connected to an AacRaid controller.
403 The non-negative integers H,L,ID (Host number, Lun, ID) denote which disk
404 on the controller is monitored.
405 In log files and email messages this disk will be identified as aacraid_disk_HH_LL_ID.
406 Please see the \fBsmartctl\fP(8) man page for further details.
409 .\" %IF OS FreeBSD Linux
411 \- [FreeBSD and Linux only] the device consists of one or more ATA disks
412 connected to a 3ware RAID controller. The non-negative integer N
413 (in the range from 0 to 127 inclusive) denotes which disk on the controller
415 In log files and email messages this disk will be identified as 3ware_disk_XXX
416 with XXX in the range from 000 to 127 inclusive.
418 Note that while you may use \fBany\fP of the 3ware SCSI logical devices /dev/tw*
419 to address \fBany\fP of the physical disks (3ware ports), error and log
420 messages will make the most sense if you always list the 3ware SCSI
421 logical device corresponding to the particular physical disks.
422 Please see the \fBsmartctl\fP(8) man page for further details.
424 .\" %ENDIF OS FreeBSD Linux
425 .\" %IF OS FreeBSD Linux Windows Cygwin
427 \- [FreeBSD, Linux, Windows and Cygwin only] the device consists of one or more SATA disks
428 connected to an Areca SATA RAID controller. The positive integer N (in the range
429 from 1 to 24 inclusive) denotes which disk on the controller is monitored.
430 In log files and email messages this disk will be identifed as
431 areca_disk_XX with XX in the range from 01 to 24 inclusive.
432 Please see the \fBsmartctl\fP(8) man page for further details.
435 \- [FreeBSD, Linux, Windows and Cygwin only] [NEW EXPERIMENTAL SMARTD FEATURE] the
436 device consists of one or more SATA or SAS disks connected to an Areca SAS RAID controller.
437 The integer N (range 1 to 128) denotes the channel (slot) and E (range
438 1 to 8) denotes the enclosure.
439 Important: This requires Areca SAS controller firmware version 1.51 or later.
441 .\" %ENDIF OS FreeBSD Linux Windows Cygwin
442 .\" %IF OS FreeBSD Linux
444 \- [FreeBSD and Linux only] the device consists of one or more SCSI/SAS or SATA disks
445 connected to a cciss RAID controller. The non-negative integer N (in the range
446 from 0 to 15 inclusive) denotes which disk on the controller is monitored.
447 In log files and email messages this disk will be identified as cciss_disk_XX
448 with XX in the range from 00 to 15 inclusive.
449 Please see the \fBsmartctl\fP(8) man page for further details.
452 \- [FreeBSD and Linux only] the device consists of one or more ATA disks
453 connected to a HighPoint RocketRAID controller. The integer L is the
454 controller id, the integer M is the channel number, and the integer N
455 is the PMPort number if it is available. The allowed values of L are
456 from 1 to 4 inclusive, M are from 1 to 128 inclusive and N from 1 to 4
457 if PMPort available. And also these values are limited by the model
458 of the HighPoint RocketRAID controller.
459 In log files and email messages this disk will be identified as
460 hpt_X/X/X and X/X/X is the same as L/M/N, note if no N indicated, N set
461 to the default value 1.
462 Please see the \fBsmartctl\fP(8) man page for further details.
464 .\" %ENDIF OS FreeBSD Linux
466 \- [NEW EXPERIMENTAL SMARTD FEATURE]
467 the device specified by this configuration entry should be ignored.
468 This allows to ignore specific devices which are detected by a following
469 DEVICESCAN configuration line.
470 It may also be used to temporary disable longer multi-line configuration entries.
471 This Directive may be used in conjunction with the other \'\-d\' Directives.
474 \- the device or its media is removable. This indicates to
476 that it should continue (instead of exiting, which is the default
477 behavior) if the device does not appear to be present when
478 \fBsmartd\fP is started. This Directive may be used in conjunction
479 with the other \'\-d\' Directives.
481 .B \-n POWERMODE[,N][,q]
482 [ATA only] This \'nocheck\' Directive is used to prevent a disk from
483 being spun-up when it is periodically polled by \fBsmartd\fP.
485 ATA disks have five different power states. In order of increasing
486 power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',
487 and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the
488 disk\'s platters are not spinning. But usually, in response to SMART
489 commands issued by \fBsmartd\fP, the disk platters are spun up. So if
490 this option is not used, then a disk which is in a low-power mode may
491 be spun up and put into a higher-power mode when it is periodically
492 polled by \fBsmartd\fP.
494 Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,
495 then it won't respond to \fBsmartd\fP commands, and so the disk won't
496 be registered as a device for \fBsmartd\fP to monitor. If a disk is in
497 any other low-power mode, then the commands issued by \fBsmartd\fP to
498 register the disk will probably cause it to spin-up.
500 The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s
501 periodic checks should still be carried out when the device is in a
502 low-power mode. It may be used to prevent a disk from being spun-up
503 by periodic \fBsmartd\fP polling. The allowed values of POWERMODE
507 \- \fBsmartd\fP will poll (check) the device regardless of its power
508 mode. This may cause a disk which is spun-down to be spun-up when
509 \fBsmartd\fP checks it. This is the default behavior if the '\-n'
510 Directive is not given.
513 \- check the device unless it is in SLEEP mode.
516 \- check the device unless it is in SLEEP or STANDBY mode. In
517 these modes most disks are not spinning, so if you want to prevent
518 a laptop disk from spinning up each time that \fBsmartd\fP polls,
519 this is probably what you want.
522 \- check the device unless it is in SLEEP, STANDBY or IDLE mode.
523 In the IDLE state, most disks are still spinning, so this is probably
526 Maximum number of skipped checks (in a row) can be specified by
527 appending positive number \',N\' to POWERMODE (like \'\-n standby,15\').
528 After N checks are skipped in a row, powermode is ignored and the
529 check is performed anyway.
531 When a periodic test is skipped, \fBsmartd\fP normally writes an
532 informal log message. The message can be suppressed by appending
533 the option \',q\' to POWERMODE (like \'\-n standby,q\').
534 This prevents a laptop disk from spinning up due to this message.
536 Both \',N\' and \',q\' can be specified together.
539 Specifies how tolerant
541 should be of SMART command failures. The valid arguments to this
545 \- do not try to monitor the disk if a mandatory SMART command fails, but
546 continue if an optional SMART command fails. This is the default.
549 \- try to monitor the disk even if it appears to lack SMART
550 capabilities. This may be required for some old disks (prior to
551 ATA-3 revision 4) that implemented SMART before the SMART standards
552 were incorporated into the ATA/ATAPI Specifications.
553 [Please see the \fBsmartctl \-T\fP command-line option.]
556 [ATA only] Enables or disables SMART Automatic Offline Testing when
558 starts up and has no further effect. The valid arguments to this
559 Directive are \fIon\fP and \fIoff\fP.
561 The delay between tests is vendor-specific, but is typically four
564 Note that SMART Automatic Offline Testing is \fBnot\fP part of the ATA
565 Specification. Please see the
567 command-line option documentation for further information about this
571 Enables or disables Attribute Autosave when \fBsmartd\fP
572 starts up and has no further effect. The valid arguments to this
573 Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices.
574 [Please see the \fBsmartctl \-S\fP command-line option.]
577 [ATA only] Check the SMART health status of the disk. If any Prefailure
578 Attributes are less than or equal to their threshold values, then disk
579 failure is predicted in less than 24 hours, and a message at loglevel
581 will be logged to syslog. [Please see the
583 command-line option.]
586 Reports increases in the number of errors in one of three SMART logs. The
587 valid arguments to this Directive are:
590 \- [ATA only] report if the number of ATA errors reported in the Summary SMART
591 error log has increased since the last check.
594 \- [ATA only] report if the number of ATA errors reported in the Extended
595 Comprehensive SMART error log has increased since the last check.
597 If both \'\-l error\' and \'\-l xerror\' are specified, smartd checks
598 the maximum of both values.
600 [Please see the \fBsmartctl \-l xerror\fP command-line option.]
603 \- report if the number of failed tests reported in the SMART
604 Self-Test Log has increased since the last check, or if the timestamp
605 associated with the most recent failed test has increased. Note that
606 such errors will \fBonly\fP be logged if you run self-tests on the
607 disk (and it fails a test!). Self-Tests can be run automatically by
608 \fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below.
609 Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP
610 and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of
611 the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP
613 [Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line
616 [ATA only] Failed self-tests outdated by a newer successful extended
617 self-test are ignored. The warning email counter is reset if the
618 number of failed self tests dropped to 0. This typically happens when
619 an extended self-test is run after all bad sectors have been reallocated.
622 \- [ATA only] report if the Offline Data Collection status has changed
623 since the last check. The report will be logged as LOG_CRIT if the new
624 status indicates an error. With some drives the status often changes,
625 therefore \'\-l offlinests\' is not enabled by '\-a\' Directive.
626 .\" %IF NOT OS Cygwin Windows
627 .\"! Appending \',ns\' (no standby) to this directive is not implemented
628 .\"! on OS_MAN_FILTER.
629 .\" %ENDIF NOT OS Cygwin Windows
630 .\" %IF OS Cygwin Windows
632 [Windows and Cygwin only] If \',ns\' (no standby) is appended to this
633 directive, smartd disables system auto standby as long as an Offline
634 Data Collection is in progress. See \'\-l selfteststs,ns\' below.
635 .\" %ENDIF OS Cygwin Windows
638 \- [ATA only] report if the Self-Test execution status has changed
639 since the last check. The report will be logged as LOG_CRIT if the new
640 status indicates an error.
641 .\" %IF NOT OS Cygwin Windows
642 .\"! Appending \',ns\' (no standby) to this directive is not implemented
643 .\"! on OS_MAN_FILTER.
644 .\" %ENDIF NOT OS Cygwin Windows
645 .\" %IF OS Cygwin Windows
647 [Windows and Cygwin only] If \',ns\' (no standby) is appended to this
648 directive, smartd disables system auto standby as long as a Self-Test
649 is in progress. This prevents that a Self-Test is aborted because the
650 OS sets the system to a standby/sleep mode when idle. Smartd check
651 interval (\'\-i\' option) should be shorter than the configured idle
652 timeout. Auto standby is not disabled if the system is running on
654 .\" %ENDIF OS Cygwin Windows
656 .I scterc,READTIME,WRITETIME
657 \- [ATA only] sets the SCT Error Recovery Control settings to the specified
658 values (deciseconds) when \fBsmartd\fP starts up and has no further effect.
659 Values of 0 disable the feature, other values less than 65 are probably
660 not supported. For RAID configurations, this is typically set to
662 [Please see the \fBsmartctl \-l scterc\fP command-line option.]
665 Sets non-SMART device settings when \fBsmartd\fP starts up and has no
667 [Please see the \fBsmartctl \-\-set\fP command-line option.]
671 \- [ATA only] Sets the Automatic Acoustic Management (AAM) feature.
674 \- [ATA only] Sets the Advanced Power Management (APM) feature.
676 .I lookahead,[on|off]
677 \- [ATA only] Sets the read look-ahead feature.
680 \- [ATA only] Sets ATA Security feature to frozen mode.
683 \- [ATA only] Sets the standby (spindown) timer and places the drive in the
687 \- [ATA only] Sets the volatile write cache feature.
690 Run Self-Tests or Offline Immediate Tests, at scheduled times. A
691 Self- or Offline Immediate Test will be run at the end of periodic
692 device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP
693 match the extended regular expression \fBREGEXP\fP. Here:
696 is the type of the test. The values that \fBsmartd\fP will try to
697 match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a
698 \fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA
699 only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As
700 soon as a match is found, the test will be started and no additional
701 matches will be sought for that device and that polling cycle.
703 To run scheduled Selective Self-Tests, use \'n\' for \fBn\fPext span,
704 \'r\' to \fBr\fPedo last span, or \'c\' to \fBc\fPontinue with next span
705 or redo last span based on status of last test.
706 The LBA range is based on the first span from the last test.
707 See the \fBsmartctl \-t select,[next|redo|cont]\fP options for
710 Some disks (e.g. WD) do not preserve the selective self test log accross
711 power cycles. If state persistence (\'\-s\' option) is enabled, the last
712 test span is preserved by smartd and used if (and only if) the selective
713 self test log is empty.
715 is the month of the year, expressed with two decimal digits. The
716 range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP
717 use a single decimal digit or the match will always fail!
719 is the day of the month, expressed with two decimal digits. The
720 range is from 01 to 31 inclusive. Do \fBnot\fP
721 use a single decimal digit or the match will always fail!
723 is the day of the week, expressed with one decimal digit. The
724 range is from 1 (Monday) to 7 (Sunday) inclusive.
726 is the hour of the day, written with two decimal digits, and given in
727 hours after midnight. The range is 00 (midnight to just before 1am)
728 to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a
729 single decimal digit or the match will always fail!
731 .\" The following two lines are a workaround for a man2html bug. Please leave them.
732 .\" They define a non-existent option; useful because man2html can't correctly reset the margins.
735 Some examples follow. In reading these, keep in mind that in extended
736 regular expressions a dot \fB\'.\'\fP matches any single character, and
737 a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP,
740 To schedule a short Self-Test between 2-3am every morning, use:
742 \fB \-s S/../.././02\fP
744 To schedule a long Self-Test between 4-5am every Sunday morning, use:
746 \fB \-s L/../../7/04\fP
748 To schedule a long Self-Test between 10-11pm on the first and
749 fifteenth day of each month, use:
751 \fB \-s L/../(01|15)/./22\fP
753 To schedule an Offline Immediate test after every midnight, 6am,
754 noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long
755 Self-Test every Saturday at 3-4am, use:
757 \fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP
759 If Long Self-Tests of a large disks take longer than the system uptime,
760 a full disk test can be performed by several Selective Self-Tests.
761 To setup a full test of a 1TB disk within 20 days (one 50GB span
762 each day), run this command once:
764 smartctl -t select,0-99999999 /dev/sda
766 To run the next test spans on Monday-Friday between 12-13am, run smartd
769 \fB \-s n/../../[1-5]/12\fP
773 Scheduled tests are run immediately following the regularly-scheduled
774 device polling, if the current local date, time, and test type, match
775 \fBREGEXP\fP. By default the regularly-scheduled device polling
776 occurs every thirty minutes after starting \fBsmartd\fP. Take caution
777 if you use the \'\-i\' option to make this polling interval more than
778 sixty minutes: the poll times may fail to coincide with any of the
779 testing times that you have specified with \fBREGEXP\fP. In this case
780 the test will be run following the next device polling.
782 Before running an offline or self-test, \fBsmartd\fP checks to be sure
783 that a self-test is not already running. If a self-test \fBis\fP
784 already running, then this running self test will \fBnot\fP be
785 interrupted to begin another test.
787 \fBsmartd\fP will not attempt to run \fBany\fP type of test if another
788 test was already started or run in the same hour.
790 To avoid performance problems during system boot, \fBsmartd\fP will
791 not attempt to run any scheduled tests following the very first
792 device polling (unless \'\-q onecheck\' is specified).
794 Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG.
795 You can use these or the '-q showtests' command-line option to verify
796 that you constructed \fBREGEXP\fP correctly. The matching order
797 (\fBL\fP before \fBS\fP before \fBC\fP before \fBO\fP) ensures that
798 if multiple test types are all scheduled for the same hour, the
799 longer test type has precedence. This is usually the desired behavior.
801 If the scheduled tests are used in conjunction with state persistence
802 (\'\-s\' option), smartd will also try to match the hours since last
803 shutdown (or 90 days at most). If any test would have been started
804 during downtime, the longest (see above) of these tests is run after
805 second device polling.
807 If the \'\-n\' directive is used and any test would have been started
808 during disk standby time, the longest of these tests is run when the
809 disk is active again.
811 Unix users: please beware that the rules for extended regular
812 expressions [\fBregex\fP(7)] are \fBnot\fP the same as the rules for
813 file-name pattern matching by the shell [\fBglob\fP(7)]. \fBsmartd\fP will
814 issue harmless informational warning messages if it detects characters
815 in \fBREGEXP\fP that appear to indicate that you have made this
819 Send a warning email to the email address \fBADD\fP if the \'\-H\',
820 \'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a
821 new error, or if a SMART command to the disk fails. This Directive
822 only works in conjunction with these other Directives (or with the
823 equivalent default \'\-a\' Directive).
825 To prevent your email in-box from getting filled up with warning
826 messages, by default only a single warning will be sent for each of
827 the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or
828 \'\-O\' even if more than one failure or error is detected or if the
829 failure or error persists. [This behavior can be modified; see the
830 \'\-M\' Directive below.]
832 To send email to more than one user, please use the following "comma
833 separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP
836 To test that email is being sent correctly, use the \'\-M test\'
837 Directive described below to send one test email message on
841 By default, email is sent using the system \fBmail\fP(1) command.
842 In order that \fBsmartd\fP find this command (normally /usr/bin/mail) the
843 executable must be in the path of the shell or environment from which
845 was started. If you wish to specify an explicit path to the mail
846 executable (for example /usr/local/bin/mail) or a custom script to
847 run, please use the \'\-M exec\' Directive below.
850 On Windows, the \'\fBBlat\fP\' mailer
851 (\fBhttp://blat.sourceforge.net/\fP) is used by default.
852 This mailer uses a different command line syntax, see
855 .\" %ENDIF OS Windows
856 Note also that there is a special argument
858 which can be given to the \'\-m\' Directive in conjunction with the \'\-M
859 exec\' Directive. Please see below for an explanation of its effect.
861 If the mailer or the shell running it produces any STDERR/STDOUT
862 output, then a snippet of that output will be copied to SYSLOG. The
863 remainder of the output is discarded. If problems are encountered in
864 sending mail, this should help you to understand and fix them. If
865 you have mail problems, we recommend running \fBsmartd\fP in debug
866 mode with the \'-d\' flag, using the \'-M test\' Directive described
868 .\" %IF ENABLE_SMARTDPLUGINDIR
869 .\" %IF NOT OS Windows
871 [NEW EXPERIMENTAL SMARTD FEATURE]
872 If a word of the comma separated list has the form \'@plugin\', a custom
873 script /usr/local/etc/smartd_warning.d/plugin is run and the word is
874 removed from the list before sending mail. The string \'plugin\' may be any
875 valid name except \'ALL\'.
876 If \'@ALL\' is specified, all scripts in /usr/local/etc/smartd_warning.d/*
878 This is handled by the script /usr/local/etc/smartd_warning.sh
879 (see also \'\-M exec\' below).
880 .\" %ENDIF NOT OS Windows
881 .\" %ENDIF ENABLE_SMARTDPLUGINDIR
884 [Windows only] [NEW EXPERIMENTAL SMARTD FEATURE]
885 If one of the following words are used as the first address in the
886 comma separated list, warning messages are sent via WTSSendMessage().
887 This displays message boxes on the desktops of the selected sessions.
888 Address \'\fBconsole\fP\' specifies the console session only,
889 \'\fBactive\fP\' specifies the console session and all active remote
890 sessions, and \'\fBconnected\fP\' specifies the console session and
891 all connected (active or waiting for login) remote sessions.
892 This is handled by the script EXEDIR/smartd_warning.cmd which runs
893 the tool EXEDIR/wtssendmsg.exe (see also \'\-M exec\' below).
894 The addresses \'\fBmsgbox\fP\' and \'\fBsysmsgbox\fP\' are now
895 deprecated and have the same effect as \'\fBconsole\fP\'.
896 .\" %ENDIF OS Windows
899 These Directives modify the behavior of the
901 email warnings enabled with the \'\-m\' email Directive described above.
902 These \'\-M\' Directives only work in conjunction with the \'\-m\'
903 Directive and can not be used without it.
905 Multiple \-M Directives may be given. If more than one of the
906 following three \-M Directives are given (example: \-M once \-M daily)
907 then the final one (in the example, \-M daily) is used.
909 The valid arguments to the \-M Directive are (one of the following
913 \- send only one warning email for each type of disk problem detected. This
914 is the default unless state persistence (\'\-s\' option) is enabled.
917 \- send additional warning reminder emails, once per day, for each type
918 of disk problem detected. This is the default if state persistence
919 (\'\-s\' option) is enabled.
922 \- send additional warning reminder emails, after a one-day interval,
923 then a two-day interval, then a four-day interval, and so on for each
924 type of disk problem detected. Each interval is twice as long as the
927 If a disk problem is no longer detected, the internal email counter is
928 reset. If the problem reappears a new warning email is sent immediately.
930 In addition, one may add zero or more of the following Directives:
933 \- send a single test email
936 startup. This allows one to verify that email is delivered correctly.
937 Note that if this Directive is used,
939 will also send the normal email warnings that were enabled with the \'\-m\' Directive,
940 in addition to the single test email!
943 \- run the executable PATH instead of the default mail command, when
945 needs to send email. PATH must point to an executable binary file or
949 [Windows only] The PATH may contain space characters.
950 Then it must be included in double quotes.
951 .\" %ENDIF OS Windows
953 By setting PATH to point to a customized script, you can make
954 \fBsmartd\fP perform useful tricks when a disk problem is detected
955 (beeping the console, shutting down the machine, broadcasting warnings
956 to all logged-in users, etc.) But please be careful. \fBsmartd\fP
957 will \fBblock\fP until the executable PATH returns, so if your
958 executable hangs, then \fBsmartd\fP will also hang.
959 .\" %IF NOT OS Windows
960 Some sample scripts are included in
961 /usr/local/share/doc/smartmontools/examplescripts/.
962 .\" %ENDIF NOT OS Windows
964 The return status of the executable is recorded by \fBsmartd\fP in
965 SYSLOG. The executable is not expected to write to STDOUT or
966 STDERR. If it does, then this is interpreted as indicating that
967 something is going wrong with your executable, and a fragment of this
968 output is logged to SYSLOG to help you to understand the problem.
969 Normally, if you wish to leave some record behind, the executable
970 should send mail or write to a file or device.
972 Before running the executable, \fBsmartd\fP sets a number of
973 environment variables. These environment variables may be used to
974 control the executable\'s behavior. The environment variables
975 exported by \fBsmartd\fP are:
977 .IP \fBSMARTD_MAILER\fP 4
978 is set to the argument of \-M exec, if present or else to \'mail\'
979 (examples: /usr/local/bin/mail, mail).
980 .IP \fBSMARTD_DEVICE\fP 4
981 is set to the device path (examples: /dev/hda, /dev/sdb).
982 .IP \fBSMARTD_DEVICETYPE\fP 4
983 is set to the device type specified by \'-d\' directive or
985 .IP \fBSMARTD_DEVICESTRING\fP 4
986 is set to the device description. For SMARTD_DEVICETYPE of ata or
987 scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers,
988 the form used is \'/dev/sdc [3ware_disk_01]\'. For HighPoint
989 RocketRAID controller, the form is \'/dev/sdd [hpt_1/1/1]\' under Linux
990 or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Areca controllers, the
991 form is \'/dev/sg2 [areca_disk_09]\' on Linux or \'/dev/arcmsr0 [areca_disk_09]\' on FreeBSD. In these cases the device string
992 contains a space and is NOT quoted. So to use $SMARTD_DEVICESTRING in a
993 shell script you should probably enclose it in double quotes.
994 .IP \fBSMARTD_DEVICEINFO\fP 4
995 is set to device identify information. It includes most of the info printed
996 by \fBsmartctl \-i\fP but uses a brief single line format.
997 This device info is also logged when \fBsmartd\fP starts up.
998 The string contains space characters and is NOT quoted.
999 .IP \fBSMARTD_FAILTYPE\fP 4
1000 gives the reason for the warning or message email. The possible values that
1001 it takes and their meanings are:
1003 \fIEmailTest\fP: this is an email test message.
1005 \fIHealth\fP: the SMART health status indicates imminent failure.
1007 \fIUsage\fP: a usage Attribute has failed.
1009 \fISelfTest\fP: the number of self-test failures has increased.
1011 \fIErrorCount\fP: the number of errors in the ATA error log has increased.
1013 \fICurrentPendingSector\fP: one of more disk sectors could not be
1014 read and are marked to be reallocated (replaced with spare sectors).
1016 \fIOfflineUncorrectableSector\fP: during off-line testing, or self-testing,
1017 one or more disk sectors could not be read.
1019 \fITemperature\fP: Temperature reached critical limit (see \-W directive).
1021 \fIFailedHealthCheck\fP: the SMART health status command failed.
1023 \fIFailedReadSmartData\fP: the command to read SMART Attribute data failed.
1025 \fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed.
1027 \fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed.
1029 \fIFailedOpenDevice\fP: the open() command to the device failed.
1030 .IP \fBSMARTD_ADDRESS\fP 4
1031 is determined by the address argument ADD of the \'\-m\' Directive.
1032 If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set.
1033 Otherwise, it is set to the comma-separated-list of email addresses
1034 given by the argument ADD, with the commas replaced by spaces
1035 (example:admin@example.com root). If more than one email address is
1036 given, then this string will contain space characters and is NOT
1037 quoted, so to use it in a shell script you may want to enclose it in
1040 .IP \fBSMARTD_ADDRCSV\fP 4
1041 [Windows only] is set to a comma-separated list of the addresses from
1043 .\" %ENDIF OS Windows
1044 .IP \fBSMARTD_MESSAGE\fP 4
1045 is set to the one sentence summary warning email message string from
1047 This message string contains space characters and is NOT quoted. So to
1048 use $SMARTD_MESSAGE in a shell script you should probably enclose it in
1050 .\" %IF NOT OS Windows
1051 .IP \fBSMARTD_FULLMESSAGE\fP 4
1052 is set to the contents of the entire email warning message string from
1054 This message string contains space and return characters and is NOT quoted. So to
1055 use $SMARTD_FULLMESSAGE in a shell script you should probably enclose it in
1057 .\" %ENDIF NOT OS Windows
1059 .IP \fBSMARTD_FULLMSGFILE\fP 4
1060 [Windows only] is the path to a temporary file containing the full message.
1061 The path may contain space characters and is NOT quoted.
1062 The file is created by the smartd_warning.cmd script and removed when
1063 the mailer or command exits.
1064 .\" %ENDIF OS Windows
1065 .IP \fBSMARTD_TFIRST\fP 4
1066 is a text string giving the time and date at which the first problem
1067 of this type was reported. This text string contains space characters
1068 and no newlines, and is NOT quoted. For example:
1070 Sun Feb 9 14:58:19 2003 CST
1071 .IP \fBSMARTD_TFIRSTEPOCH\fP 4
1072 is an integer, which is the unix epoch (number of seconds since Jan 1,
1073 1970) for \fBSMARTD_TFIRST\fP.
1074 .IP \fBSMARTD_PREVCNT\fP 4
1075 is an integer specifying the number of previous messages sent.
1076 It is set to \'0\' for the first message.
1077 .IP \fBSMARTD_NEXTDAYS\fP 4
1078 is an integer specifying the number of days until the next message will be sent.
1079 It it set to empty on \'\-M once\' and set to \'1\' on \'\-M daily\'.
1081 .\" The following two lines are a workaround for a man2html bug. Please leave them.
1082 .\" They define a non-existent option; useful because man2html can't correctly reset the margins.
1085 The shell which is used to run PATH is system-dependent. For vanilla
1086 Linux/glibc it\'s bash. For other systems, the man page for
1087 \fBpopen\fP(3) should say what shell is used.
1089 If the \'\-m ADD\' Directive is given with a normal address argument,
1090 then the executable pointed to by PATH will be run in a shell with
1091 STDIN receiving the body of the email message, and with the same
1092 command-line arguments:
1094 -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS
1096 that would normally be provided to \'mail\'. Examples include:
1098 .B -m user@home -M exec /usr/bin/mail
1099 .B -m admin@work -M exec /usr/local/bin/mailto
1100 .B -m root -M exec /Example_1/shell/script/below
1104 [Windows only] On Windows, the syntax of the \'\fBBlat\fP\' mailer is
1107 - -q -subject "%SMARTD_SUBJECT%" -to %SMARTD_ADDRCSV%
1110 .\" %ENDIF OS Windows
1111 If the \'\-m ADD\' Directive is given with the special address argument
1113 then the executable pointed to by PATH is run in a shell with
1117 command-line arguments, for example:
1119 .B -m <nomailer> -M exec /Example_2/shell/script/below
1121 If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP
1122 assumes that something is going wrong, and a snippet of that output
1123 will be copied to SYSLOG. The remainder of the output is then
1126 Some EXAMPLES of scripts that can be used with the \'\-M exec\'
1127 Directive are given below.
1128 .\" %IF NOT OS Windows
1129 Some sample scripts are also included in
1130 /usr/local/share/doc/smartmontools/examplescripts/.
1131 .\" %ENDIF NOT OS Windows
1133 [NEW EXPERIMENTAL SMARTD FEATURE] The executable is run by the script
1134 .\" %IF NOT OS Windows
1135 /usr/local/etc/smartd_warning.sh.
1136 .\" %ENDIF NOT OS Windows
1138 (Windows: EXEDIR/smartd_warning.cmd)
1141 .\"! EXEDIR/smartd_warning.cmd.
1142 .\" %ENDIF OS Windows
1143 This script formats subject and full message based on SMARTD_MESSAGE and other
1144 environment variables set by \fBsmartd\fP.
1145 The environment variables
1146 .\" %IF NOT OS Windows
1147 SMARTD_SUBJECT and SMARTD_FULLMESSAGE
1148 .\" %ENDIF NOT OS Windows
1150 (Windows: SMARTD_SUBJECT, SMARTD_FULLMSGFILE and SMARTD_ADDRCSV)
1153 .\"! SMARTD_SUBJECT, SMARTD_FULLMSGFILE and SMARTD_ADDRCSV
1154 .\" %ENDIF OS Windows
1155 are set by the script before running the executable.
1158 [ATA only] Check for \'failure\' of any Usage Attributes. If these
1159 Attributes are less than or equal to the threshold, it does NOT indicate
1160 imminent disk failure. It "indicates an advisory condition where the usage
1161 or age of the device has exceeded its intended design life period."
1162 [Please see the \fBsmartctl \-A\fP command-line option.]
1165 [ATA only] Report anytime that a Prefail Attribute has changed
1166 its value since the last check. [Please see the
1168 command-line option.]
1171 [ATA only] Report anytime that a Usage Attribute has changed its value
1172 since the last check. [Please see the
1174 command-line option.]
1177 [ATA only] Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
1178 Tracks changes in \fIall\fP device Attributes (both Prefailure and
1179 Usage). [Please see the \fBsmartctl\fP \-A command-line option.]
1182 [ATA only] Ignore device Attribute number \fBID\fP when checking for failure
1183 of Usage Attributes. \fBID\fP must be a decimal integer in the range
1184 from 1 to 255. This Directive modifies the behavior of the \'\-f\'
1185 Directive and has no effect without it.
1187 This is useful, for example, if you have a very old disk and don\'t
1188 want to keep getting messages about the hours-on-lifetime Attribute
1189 (usually Attribute 9) failing. This Directive may appear multiple
1190 times for a single device, if you want to ignore multiple Attributes.
1193 [ATA only] Ignore device Attribute \fBID\fP when tracking changes in the
1194 Attribute values. \fBID\fP must be a decimal integer in the range
1195 from 1 to 255. This Directive modifies the behavior of the \'\-p\',
1196 \'\-u\', and \'\-t\' tracking Directives and has no effect without one
1199 This is useful, for example, if one of the device Attributes is the disk
1200 temperature (usually Attribute 194 or 231). It\'s annoying to get reports
1201 each time the temperature changes. This Directive may appear multiple
1202 times for a single device, if you want to ignore multiple Attributes.
1205 [ATA only] When tracking, report the \fIRaw\fP value of Attribute \fBID\fP
1206 along with its (normally reported) \fINormalized\fP value. \fBID\fP must
1207 be a decimal integer in the range from 1 to 255. This Directive modifies
1208 the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives
1209 and has no effect without one of them. This Directive may be given
1212 A common use of this Directive is to track the device Temperature
1213 (often ID=194 or 231).
1215 If the optional flag \'!\' is appended, a change of the Normalized
1216 value is considered critical. The report will be logged as LOG_CRIT
1217 and a warning email will be sent if \'\-m\' is specified.
1220 [ATA only] When tracking, report whenever the \fIRaw\fP value of Attribute
1221 \fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes
1222 of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal
1223 integer in the range from 1 to 255. This Directive modifies the
1224 behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and
1225 has no effect without one of them. This Directive may be given
1228 If this Directive is given, it automatically implies the \'\-r\'
1229 Directive for the same Attribute, so that the Raw value of the
1230 Attribute is reported.
1232 A common use of this Directive is to track the device Temperature
1233 (often ID=194 or 231). It is also useful for understanding how
1234 different types of system behavior affects the values of certain
1237 If the optional flag \'!\' is appended, a change of the Raw
1238 value is considered critical. The report will be logged as
1239 LOG_CRIT and a warning email will be sent if \'\-m\' is specified.
1240 An example is \'-R 5!\' to warn when new sectors are reallocated.
1243 [ATA only] Report if the current number of pending sectors is
1244 non-zero. Here \fBID\fP is the id number of the Attribute whose raw
1245 value is the Current Pending Sector count. The allowed range of
1246 \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
1247 ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to
1248 \fB\-C 197\fP (since Attribute 197 is generally used to monitor
1249 pending sectors). If the name of this Attribute is changed by a
1250 \'\-v 197,FORMAT,NAME\' directive, the default is changed to
1253 If \'+\' is specified, a report is only printed if the number of sectors
1254 has increased between two check cycles. Some disks do not reset this
1255 attribute when a bad sector is reallocated.
1256 See also \'\-v 197,increasing\' below.
1258 The warning email counter is reset if the number of pending sectors
1259 dropped to 0. This typically happens when all pending sectors have
1260 been reallocated or could be read again.
1262 A pending sector is a disk sector (containing 512 bytes of your data)
1263 which the device would like to mark as ``bad" and reallocate.
1264 Typically this is because your computer tried to read that sector, and
1265 the read failed because the data on it has been corrupted and has
1266 inconsistent Error Checking and Correction (ECC) codes. This is
1267 important to know, because it means that there is some unreadable data
1268 on the disk. The problem of figuring out what file this data belongs
1269 to is operating system and file system specific. You can typically
1270 force the sector to reallocate by writing to it (translation: make the
1271 device substitute a spare good sector for the bad one) but at the
1272 price of losing the 512 bytes of data stored there.
1275 [ATA only] Report if the number of offline uncorrectable sectors is
1276 non-zero. Here \fBID\fP is the id number of the Attribute whose raw
1277 value is the Offline Uncorrectable Sector count. The allowed range of
1278 \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
1279 ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to
1280 \fB\-U 198\fP (since Attribute 198 is generally used to monitor
1281 offline uncorrectable sectors). If the name of this Attribute is changed
1282 by a \'\-v 198,FORMAT,NAME\' (except \'\-v 198,FORMAT,Offline_Scan_UNC_SectCt\'),
1283 directive, the default is changed to \fB\-U 0\fP.
1285 If \'+\' is specified, a report is only printed if the number of sectors
1286 has increased since the last check cycle. Some disks do not reset this
1287 attribute when a bad sector is reallocated.
1288 See also \'\-v 198,increasing\' below.
1290 The warning email counter is reset if the number of offline uncorrectable
1291 sectors dropped to 0. This typically happens when all offline uncorrectable
1292 sectors have been reallocated or could be read again.
1294 An offline uncorrectable sector is a disk sector which was not
1295 readable during an off-line scan or a self-test. This is important
1296 to know, because if you have data stored in this disk sector, and you
1297 need to read it, the read will fail. Please see the previous \'\-C\'
1298 option for more details.
1300 .B \-W DIFF[,INFO[,CRIT]]
1301 Report if the current temperature had changed by at least \fBDIFF\fP
1302 degrees since last report, or if new min or max temperature is detected.
1303 Report or Warn if the temperature is greater or equal than one of
1304 \fBINFO\fP or \fBCRIT\fP degrees Celsius.
1305 If the limit \fBCRIT\fP is reached, a message with loglevel
1306 \fB\'LOG_CRIT\'\fP will be logged to syslog and a warning email
1307 will be send if \'\-m\' is specified. If only the limit \fBINFO\fP is
1308 reached, a message with loglevel \fB\'LOG_INFO\'\fP will be logged.
1310 The warning email counter is reset if the temperature dropped below
1311 \fBINFO\fP or \fBCRIT\fP-5 if \fBINFO\fP is not specified.
1313 If this directive is used in conjunction with state persistence
1314 (\'\-s\' option), the min and max temperature values are preserved
1315 across boot cycles. The minimum temperature value is not updated
1316 during the first 30 minutes after startup.
1318 To disable any of the 3 reports, set the corresponding limit to 0.
1319 Trailing zero arguments may be omitted. By default, all temperature
1320 reports are disabled (\'-W 0\').
1322 To track temperature changes of at least 2 degrees, use:
1326 To log informal messages on temperatures of at least 40 degrees, use:
1330 For warning messages/mails on temperatures of at least 45 degrees, use:
1334 To combine all of the above reports, use:
1339 For ATA devices, smartd interprets Attribute 194 or 190 as Temperature Celsius
1340 by default. This can be changed to Attribute 9 or 220 by the drive
1341 database or by the \'\-v 9,temp\' or \'\-v 220,temp\' directive.
1344 [ATA only] Modifies the behavior of \fBsmartd\fP to compensate for some
1345 known and understood device firmware bug. This directive may be used
1346 multiple times. The valid arguments are:
1349 \- Assume that the device firmware obeys the ATA specifications. This
1350 is the default, unless the device has presets for \'\-F\' in the
1351 drive database. Using this directive will override any preset values.
1354 \- Suppresses read attempts of SMART or GP Log Directory.
1355 Support for all standard logs is assumed without an actual check.
1356 Some Intel SSDs may freeze if log address 0 is read.
1359 \- In some Samsung disks (example: model SV4012H Firmware Version:
1360 RM100-08) some of the two- and four-byte quantities in the SMART data
1361 structures are byte-swapped (relative to the ATA specification).
1362 Enabling this option tells \fBsmartd\fP to evaluate these quantities
1363 in byte-reversed order. Some signs that your disk needs this option
1364 are (1) no self-test log printed, even though you have run self-tests;
1365 (2) very large numbers of ATA errors reported in the ATA error log;
1366 (3) strange and impossible values for the ATA error log timestamps.
1369 \- In some Samsung disks the number of ATA errors reported is byte swapped.
1370 Enabling this option tells \fBsmartd\fP to evaluate this quantity in
1371 byte-reversed order.
1374 \- Some Samsung disks (at least SP2514N with Firmware VF100-37) report
1375 a self-test still in progress with 0% remaining when the test was already
1376 completed. If this directive is specified, \fBsmartd\fP will not skip the
1377 next scheduled self-test (see Directive \'\-s\' above) in this case.
1380 \- This only affects \fBsmartctl\fP.
1382 [Please see the \fBsmartctl \-F\fP command-line option.]
1384 .B \-v ID,FORMAT[:BYTEORDER][,NAME]
1385 [ATA only] Sets a vendor-specific raw value print FORMAT, an optional
1386 BYTEORDER and an optional NAME for Attribute ID.
1387 This directive may be used multiple times.
1388 Please see \fBsmartctl -v\fP command-line option for further details.
1390 The following arguments affect smartd warning output:
1393 \- Raw Attribute number 197 (Current Pending Sector Count) is not
1394 reset if uncorrectable sectors are reallocated. This sets \'-C 197+\'
1395 if no other \'-C\' directive is specified.
1398 \- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not
1399 reset if uncorrectable sectors are reallocated. This sets \'-U 198+\'
1400 if no other \'-U\' directive is specified.
1403 [ATA only] Specifies whether \fBsmartd\fP should use any preset options
1404 that are available for this drive.
1405 The valid arguments to this Directive are:
1408 \- use any presets that are available for this drive. This is the default.
1411 \- do not use any presets for this drive.
1414 \- show the presets listed for this drive in the database.
1417 \- show the presets that are available for all drives and then exit.
1421 command-line option.]
1424 Equivalent to turning on all of the following Directives:
1426 to check the SMART health status,
1428 to report failures of Usage (rather than Prefail) Attributes,
1430 to track changes in both Prefailure and Usage Attributes,
1432 to report increases in the number of ATA errors,
1433 .B \'\-l\ selftest\'
1434 to report increases in the number of Self-Test Log errors,
1435 .B \'\-l\ selfteststs\'
1436 to report changes of Self-Test execution status,
1438 to report nonzero values of the current pending sector count, and
1440 to report nonzero values of the offline pending sector count.
1442 Note that \-a is the default for ATA devices. If none of these other
1443 Directives is given, then \-a is assumed.
1446 Comment: ignore the remainder of the line.
1449 Continuation character: if this is the last non-white or non-comment
1450 character on a line, then the following line is a continuation of the current
1453 If you are not sure which Directives to use, I suggest experimenting
1454 for a few minutes with
1456 to see what SMART functionality your disk(s) support(s). If you do
1457 not like voluminous syslog messages, a good choice of
1459 configuration file Directives might be:
1461 .B \-H \-l\ selftest \-l\ error \-f.
1463 If you want more frequent information, use:
1467 .B ADDITIONAL DETAILS ABOUT DEVICESCAN
1468 If a non-comment entry in the configuration file is the text
1469 string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will
1470 ignore any remaining lines in the configuration file, and will scan
1471 for devices (see also \fBsmartd\fP(8) man page).
1473 If \fBDEVICESCAN\fP is not followed by any Directives, then smartd
1474 will scan for both ATA and SCSI devices, and will monitor all possible
1475 SMART properties of any devices that are found.
1477 \fBDEVICESCAN\fP may optionally be followed by any valid Directives,
1478 which will be applied to all devices that are found in the scan. For
1481 .B DEVICESCAN -m root@example.com
1483 will scan for all devices, and then monitor them. It will send one
1484 email warning per device for any problems that are found.
1486 .B DEVICESCAN -d ata -m root@example.com
1488 will do the same, but restricts the scan to ATA devices only.
1490 .B DEVICESCAN -H -d ata -m root@example.com
1492 will do the same, but only monitors the SMART health status of the
1493 devices, (rather than the default \-a, which monitors all SMART
1496 [NEW EXPERIMENTAL SMARTD FEATURE]
1497 Configuration entries for specific devices may precede the \fBDEVICESCAN\fP entry.
1500 .B DEFAULT -m root@example.com
1501 .B /dev/sda -s S/../.././02
1502 .B /dev/sdc -d ignore
1503 .B DEVICESCAN -s L/../.././02
1505 will scan for all devices except /dev/sda and /dev/sdc, monitor them, and run a long
1506 test between 2-3am every morning. Device /dev/sda will also be monitored, but
1507 only a short test will be run. Device /dev/sdc will be ignored.
1508 Warning emails will be sent for all monitored devices.
1511 .B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\'
1512 These are two examples of shell scripts that can be used with the \'\-M
1513 exec PATH\' Directive described previously. The paths to these scripts
1514 and similar executables is the PATH argument to the \'\-M exec PATH\'
1517 Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'. It appends
1520 to the output of the smartd email warning message and sends it to ADDRESS.
1526 # Save the email message (STDIN) to a file:
1529 # Append the output of smartctl -a to the message:
1530 /usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
1532 # Now email the message to the user at address ADD:
1533 /usr/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
1537 Example 2: This script is for use with \'\-m <nomailer> \-M exec
1538 PATH\'. It warns all users about a disk problem, waits 30 seconds, and
1539 then powers down the machine.
1545 # Warn all users of a problem
1547 Problem detected with disk: $SMARTD_DEVICESTRING
1548 Warning message from smartd is: $SMARTD_MESSAGE
1549 Shutting down machine in 30 seconds...
1552 # Wait half a minute
1555 # Power down the machine
1556 /sbin/shutdown -hf now
1560 Some example scripts are distributed with the smartmontools package,
1561 in /usr/local/share/doc/smartmontools/examplescripts/.
1563 Please note that these scripts typically run as root, so any files
1564 that they read/write should not be writable by ordinary users or
1565 reside in directories like /tmp that are writable by ordinary users
1566 and may expose your system to symlink attacks.
1568 As previously described, if the scripts write to STDOUT or STDERR,
1569 this is interpreted as indicating that there was an internal error
1570 within the script, and a snippet of STDOUT/STDERR is logged to SYSLOG.
1571 The remainder is flushed.
1573 .\" %IF NOT OS Windows
1576 .B /usr/local/etc/smartd.conf
1577 full path of this file.
1579 .\" %ENDIF NOT OS Windows
1581 \fBsmartd\fP(8), \fBsmartctl\fP(8),
1582 \fBmail\fP(1), \fBregex\fP(7).
1584 .SH SVN ID OF THIS PAGE
1585 $Id: smartd.conf.5.in 3965 2014-07-20 14:46:41Z chrfranke $
projects / mirror_smartmontools-debian.git / blob