]> git.proxmox.com Git - mirror_smartmontools-debian.git/blob - smartd.conf.5.in
Imported Upstream version 5.39.1+svn3060
[mirror_smartmontools-debian.git] / smartd.conf.5.in
1 .ig
2 Copyright (C) 2002-8 Bruce Allen <smartmontools-support@lists.sourceforge.net>
3
4 $Id: smartd.conf.5.in 3001 2009-12-19 15:25:27Z chrfranke $
5
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
9 version.
10
11 You should have received a copy of the GNU General Public License (for
12 example COPYING); if not, write to the Free Software Foundation, Inc., 675
13 Mass Ave, Cambridge, MA 02139, USA.
14
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/
19 ..
20 .TH SMARTD.CONF 5 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE
21 .SH NAME
22 \fBsmartd.conf\fP \- SMART Disk Monitoring Daemon Configuration File\fP
23
24 .SH FULL PATH
25 .B /usr/local/etc/smartd.conf
26
27 .SH PACKAGE VERSION
28 CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME
29
30 .SH DESCRIPTION
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
34 SCSI-3 hard drives.
35
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
43 running.
44
45 .\" DO NOT MODIFY THIS OR THE FOLLOWING TWO LINES. WHAT FOLLOWS
46 .\" IS AUTOMATICALLY INCLUDED FROM THE FILE smartd.8.in
47 .\" STARTINCLUDE
48
49 .SH CONFIGURATION FILE /usr/local/etc/smartd.conf
50 In the absence of a configuration file, under Linux
51 \fBsmartd\fP
52 will try to open the 20 ATA devices
53 .B /dev/hd[a-t]
54 and the 26 SCSI devices
55 .B /dev/sd[a-z].
56 Under FreeBSD,
57 \fBsmartd\fP
58 will try to open all existing ATA devices (with entries in /dev)
59 .B /dev/ad[0-9]+
60 and all existing SCSI devices (using CAM subsystem).
61 Under NetBSD/OpenBSD,
62 \fBsmartd\fP
63 will try to open all existing ATA devices (with entries in /dev)
64 .B /dev/wd[0-9]+c
65 and all existing SCSI devices
66 .B /dev/sd[0-9]+c.
67 Under Solaris \fBsmartd\fP will try to open all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk
68 devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.
69 Under Windows \fBsmartd\fP will try to open all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")
70 for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP
71 (bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,
72 and \fB"/dev/scsi[0-9][0-7]"\fP (ASPI adapter 0-9, ID 0-7) for SCSI
73 devices on all versions of Windows.
74 Under Darwin, \fBsmartd\fP will open any ATA block storage device.
75
76 This can be annoying if you have an ATA or SCSI device that hangs or
77 misbehaves when receiving SMART commands. Even if this causes no
78 problems, you may be annoyed by the string of error log messages about
79 block-major devices that can\'t be found, and SCSI devices that can\'t
80 be opened.
81
82 One can avoid this problem, and gain more control over the types of
83 events monitored by
84 \fBsmartd\fP,
85 by using the configuration file
86 .B /usr/local/etc/smartd.conf.
87 This file contains a list of devices to monitor, with one device per
88 line. An example file is included with the
89 .B smartmontools
90 distribution. You will find this sample configuration file in
91 \fB/usr/local/share/doc/smartmontools-5.1/\fP. For security, the configuration file
92 should not be writable by anyone but root. The syntax of the file is as
93 follows:
94 .IP \(bu 4
95 There should be one device listed per line, although you may have
96 lines that are entirely comments or white space.
97 .IP \(bu 4
98 Any text following a hash sign \'#\' and up to the end of the line is
99 taken to be a comment, and ignored.
100 .IP \(bu 4
101 Lines may be continued by using a backslash \'\e\' as the last
102 non-whitespace or non-comment item on a line.
103 .IP \(bu 4
104 Note: a line whose first character is a hash sign \'#\' is treated as
105 a white-space blank line, \fBnot\fP as a non-existent line, and will
106 \fBend\fP a continuation line.
107 .PP 0
108 .fi
109 Here is an example configuration file. It\'s for illustrative purposes
110 only; please don\'t copy it onto your system without reading to the end
111 of the
112 .B DIRECTIVES
113 Section below!
114
115 .nf
116 .B ################################################
117 .B # This is an example smartd startup config file
118 .B # /usr/local/etc/smartd.conf for monitoring three
119 .B # ATA disks, three SCSI disks, six ATA disks
120 .B # behind two 3ware controllers, three SATA disks
121 .B # directly connected to the HighPoint Rocket-
122 .B # RAID controller, two SATA disks connected to
123 .B # the HighPoint RocketRAID controller via a pmport
124 .B # device, four SATA disks connected to an Areca
125 .B # RAID controller, and one SATA disk.
126 .B #
127 .nf
128 .B # First ATA disk on two different interfaces. On
129 .B # the second disk, start a long self-test every
130 .B # Sunday between 3 and 4 am.
131 .B #
132 .B \ \ /dev/hda -a -m admin@example.com,root@localhost
133 .B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03
134 .B #
135 .nf
136 .B # SCSI disks. Send a TEST warning email to admin on
137 .B # startup.
138 .B #
139 .B \ \ /dev/sda
140 .B \ \ /dev/sdb -m admin@example.com -M test
141 .B #
142 .nf
143 .B # Strange device. It\'s SCSI. Start a scheduled
144 .B # long self test between 5 and 6 am Monday/Thursday
145 .B \ \ /dev/weird -d scsi -s L/../../(1|4)/05
146 .B #
147 .nf
148 .B # An ATA disk may appear as a SCSI device to the
149 .B # OS. If a SCSI to ATA Translation (SAT) layer
150 .B # is between the OS and the device then this can be
151 .B # flagged with the '-d sat' option. This situation
152 .B # may become common with SATA disks in SAS and FC
153 .B # environments.
154 .B \ \ /dev/sda -a -d sat
155 .B #
156 .nf
157 .B # Three disks connected to a MegaRAID controller
158 .B # Start short self-tests daily between 1-2, 2-3, and
159 .B # 3-4 am.
160 .B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01
161 .B \ \ /dev/sda -d megaraid,1 -a -s S/../.././02
162 .B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03
163 .B
164 .B #
165 .nf
166 .B # Four ATA disks on a 3ware 6/7/8000 controller.
167 .B # Start short self-tests daily between midnight and 1am,
168 .B # 1-2, 2-3, and 3-4 am. Starting with the Linux 2.6
169 .B # kernel series, /dev/sdX is deprecated in favor of
170 .B # /dev/tweN. For example replace /dev/sdc by /dev/twe0
171 .B # and /dev/sdd by /dev/twe1.
172 .B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00
173 .B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01
174 .B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02
175 .B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03
176 .B #
177 .nf
178 .B # Two ATA disks on a 3ware 9000 controller.
179 .B # Start long self-tests Sundays between midnight and
180 .B # 1am and 2-3 am
181 .B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00
182 .B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02
183 .B #
184 .nf
185 .B # Three SATA disks on a HighPoint RocketRAID controller.
186 .B # Start short self-tests daily between 1-2, 2-3, and
187 .B # 3-4 am.
188 .B # under Linux
189 .B \ \ /dev/sde -d hpt,1/1 -a -s S/../.././01
190 .B \ \ /dev/sde -d hpt,1/2 -a -s S/../.././02
191 .B \ \ /dev/sde -d hpt,1/3 -a -s S/../.././03
192 .B # or under FreeBSD
193 .B # /dev/hptrr -d hpt,1/1 -a -s S/../.././01
194 .B # /dev/hptrr -d hpt,1/2 -a -s S/../.././02
195 .B # /dev/hptrr -d hpt,1/3 -a -s S/../.././03
196 .B #
197 .nf
198 .B # Two SATA disks connected to a HighPoint RocketRAID
199 .B # via a pmport device. Start long self-tests Sundays
200 .B # between midnight and 1am and 2-3 am.
201 .B # under Linux
202 .B \ \ /dev/sde -d hpt,1/4/1 -a -s L/../../7/00
203 .B \ \ /dev/sde -d hpt,1/4/2 -a -s L/../../7/02
204 .B # or under FreeBSD
205 .B # /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00
206 .B # /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02
207 .B #
208 .nf
209 .B # Three SATA disks connected to an Areca
210 .B # RAID controller. Start long self-tests Sundays
211 .B # between midnight and 3 am.
212 .B \ \ /dev/sg2 -d areca,1 -a -s L/../../7/00
213 .B \ \ /dev/sg2 -d areca,2 -a -s L/../../7/01
214 .B \ \ /dev/sg2 -d areca,3 -a -s L/../../7/02
215 .B #
216 .nf
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:
222 .B #
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
229 .B #
230 .B ################################################
231 .fi
232
233 .PP
234 .SH CONFIGURATION FILE DIRECTIVES
235 .PP
236
237 If the first non-comment entry in the configuration file is the text
238 string
239 .B DEVICESCAN
240 in capital letters, then
241 \fBsmartd\fP
242 will ignore any remaining lines in the configuration file, and will
243 scan for devices.
244 .B DEVICESCAN
245 may optionally be followed by Directives that will apply to all
246 devices that are found in the scan. Please see below for additional
247 details.
248
249 .sp 2
250 The following are the Directives that may appear following the device
251 name or
252 .B DEVICESCAN
253 on any line of the
254 .B /usr/local/etc/smartd.conf
255 configuration file. Note that
256 .B these are NOT command-line options for
257 \fBsmartd\fP.
258 The Directives below may appear in any order, following the device
259 name.
260
261 .B For an ATA device,
262 if no Directives appear, then the device will be monitored
263 as if the \'\-a\' Directive (monitor all SMART properties) had been given.
264
265 .B If a SCSI disk is listed,
266 it will be monitored at the maximum implemented level: roughly
267 equivalent to using the \'\-H \-l selftest\' options for an ATA disk.
268 So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and
269 \'\-M\', the Directives below are ignored for SCSI disks. For SCSI
270 disks, the \'\-m\' Directive sends a warning email if the SMART status
271 indicates a disk failure or problem, if the SCSI inquiry about disk
272 status fails, or if new errors appear in the self-test log.
273
274 .B If a 3ware controller is used
275 then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?
276 or /dev/twa?) must be listed, along with the \'\-d 3ware,N\' Directive
277 (see below). The individual ATA disks hosted by the 3ware controller
278 appear to \fBsmartd\fP as normal ATA devices. Hence all the ATA
279 directives can be used for these disks (but see note below).
280
281 .B If an Areca controller is used
282 then the corresponding SCSI generic device (/dev/sg?) must be listed,
283 along with the \'\-d areca,N\' Directive (see below). The individual
284 SATA disks hosted by the Areca controller appear to \fBsmartd\fP as
285 normal ATA devices. Hence all the ATA directives can be used for
286 these disks. Areca firmware version 1.46 or later which supports
287 smartmontools must be used; Please see the \fBsmartctl\fP(8) man page
288 for further details.
289
290 .TP
291 .B \-d TYPE
292 Specifies the type of the device. This Directive may be used multiple
293 times for one device, but the arguments \fIata\fP, \fIscsi\fP,
294 \fIsat\fP, \fImarvell\fP, \fIcciss,N\fP, \fIareca,N\fP, \fImegaraid,N\fP
295 and \fI3ware,N\fP are mutually-exclusive. If more than one is given then
296 \fBsmartd\fP will use the last one which appears.
297
298 If none of these three arguments is given, then \fBsmartd\fP will
299 first attempt to guess the device type by looking at whether the sixth
300 character in the device name is an \'s\' or an \'h\'. This will work for
301 device names like /dev/hda or /dev/sdb, and corresponds to choosing
302 \fIata\fP or \fIscsi\fP respectively. If
303 \fBsmartd\fP
304 can\'t guess from this sixth character, then it will simply try to
305 access the device using first ATA and then SCSI ioctl()s.
306
307 The valid arguments to this Directive are:
308
309 .I ata
310 \- the device type is ATA. This prevents
311 \fBsmartd\fP
312 from issuing SCSI commands to an ATA device.
313
314 .I scsi
315 \- the device type is SCSI. This prevents
316 \fBsmartd\fP
317 from issuing ATA commands to a SCSI device.
318
319 .I sat
320 \- the device type is SCSI to ATA Translation (SAT).
321 \fBsmartd\fP
322 will generate ATA (smart) commands and then package them in
323 the SAT defined ATA PASS THROUGH SCSI commands. The commands
324 are then routed through the SCSI pass through interface to the
325 operating system. There are two types of ATA PASS THROUGH
326 SCSI commands: a 12 byte and 16 byte variant.
327 \fBsmartd\fP
328 can use either and defaults to the 16 byte variant. This can
329 be overridden with this syntax: \'\-d sat,12\' or \'\-d sat,16\'.
330
331 .I marvell
332 \- Under Linux, interact with SATA disks behind Marvell chip-set
333 controllers (using the Marvell rather than libata driver).
334
335 .I megaraid,N
336 \- the device consists of one or more SCSI/SAS/SATA disks connected
337 to a MegaRAID controller. The non-negative integer N (in the range
338 of 0 to 127 inclusive) denotes which disk on the controller is monitored.
339 In log files and email messages this disk will be identified as
340 megaraid_disk_XXX with XXX in the range from 000 to 127 inclusive.
341
342 .I 3ware,N
343 \- the device consists of one or more ATA disks connected to a 3ware
344 RAID controller. The non-negative integer N (in the range from 0 to 127
345 inclusive) denotes which disk on the controller is monitored. In log
346 files and email messages this disk will be identified as 3ware_disk_XXX
347 with XXX in the range from 000 to 127 inclusive.
348
349 This Directive may at first appear confusing, because the 3ware
350 controller is a SCSI device (such as /dev/sda) and should be listed as
351 such in the the configuration file.
352 However when the \'\-d 3ware,N\'
353 Directive is used, then the corresponding disk is addressed using
354 native ATA commands which are \'passed through\' the SCSI driver. All
355 ATA Directives listed in this man page may be used. Note that while
356 you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to
357 address \fBany\fP of the physical disks (3ware ports), error and log
358 messages will make the most sense if you always list the 3ware SCSI
359 logical device corresponding to the particular physical disks. Please
360 see the \fBsmartctl\fP(8) man page for further details.
361
362 ATA disks behind 3ware controllers may alternatively be accessed via a
363 character device interface /dev/twe0-15 (3ware 6000/7000/8000
364 controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note
365 that the 9000 series controllers may \fBonly\fP be accessed using the
366 character device interface /dev/twa0-15 and not the SCSI device
367 interface /dev/sd?. Please see the \fBsmartctl\fP(8) man page for
368 further details.
369
370 Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'
371 (\fB-S on\fP) and \'Enable Automatic Offline\' (\fB-o on\fP) commands
372 to the disk, if the SCSI interface is used, and produce these types of
373 harmless syslog error messages instead: \fB\'3w-xxxx: tw_ioctl():
374 Passthru size (123392) too big\'\fP. This can be fixed by upgrading to
375 version 1.02.00.037 or later of the 3w-xxxx driver, or by applying a
376 patch to older versions. See
377 \fBhttp://smartmontools.sourceforge.net/\fP for instructions.
378 Alternatively use the character device interfaces /dev/twe0-15 (3ware
379 6/7/8000 series controllers) or /dev/twa0-15 (3ware 9000 series
380 controllers).
381
382 .I areca,N
383 \- the device consists of one or more SATA disks connected to an Areca
384 SATA RAID controller. The positive integer N (in the range from 1 to
385 24 inclusive) denotes which disk on the controller is monitored. In
386 log files and email messages this disk will be identifed as
387 areca_disk_XX with XX in the range from 01 to 24 inclusive.
388
389 .I cciss,N
390 \- the device consists of one or more SCSI disks connected to a cciss
391 RAID controller. The non-negative integer N (in the range from 0 to 15
392 inclusive) denotes which disk on the controller is monitored. In log
393 files and email messages this disk will be identified as cciss_disk_XX
394 with XX in the range from 00 to 15 inclusive.
395
396 .B 3ware, MegaRAID, Areca and cciss controllers are currently ONLY supported under Linux.
397
398 .I hpt,L/M/N
399 \- the device consists of one or more ATA disks connected to a HighPoint
400 RocketRAID controller. The integer L is the controller id, the integer M
401 is the channel number, and the integer N is the PMPort number if it is
402 available. The allowed values of L are from 1 to 4 inclusive, M are from
403 1 to 8 inclusive and N from 1 to 4 if PMPort available. And also these
404 values are limited by the model of the HighPoint RocketRAID controller.
405 In log files and email messages this disk will be identified as
406 hpt_X/X/X and X/X/X is the same as L/M/N, note if no N indicated, N set
407 to the default value 1.
408
409 .B HighPoint RocketRAID controllers are currently ONLY supported under Linux and FreeBSD.
410
411 .I removable
412 \- the device or its media is removable. This indicates to
413 \fBsmartd\fP
414 that it should continue (instead of exiting, which is the default
415 behavior) if the device does not appear to be present when
416 \fBsmartd\fP is started. This Directive may be used in conjunction
417 with the other \'\-d\' Directives.
418
419 .TP
420 .B \-n POWERMODE[,N][,q]
421 This \'nocheck\' Directive is used to prevent a disk from being
422 spun-up when it is periodically polled by \fBsmartd\fP.
423
424 ATA disks have five different power states. In order of increasing
425 power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',
426 and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the
427 disk\'s platters are not spinning. But usually, in response to SMART
428 commands issued by \fBsmartd\fP, the disk platters are spun up. So if
429 this option is not used, then a disk which is in a low\-power mode may
430 be spun up and put into a higher\-power mode when it is periodically
431 polled by \fBsmartd\fP.
432
433 Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,
434 then it won't respond to \fBsmartd\fP commands, and so the disk won't
435 be registered as a device for \fBsmartd\fP to monitor. If a disk is in
436 any other low\-power mode, then the commands issued by \fBsmartd\fP to
437 register the disk will probably cause it to spin\-up.
438
439 The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s
440 periodic checks should still be carried out when the device is in a
441 low\-power mode. It may be used to prevent a disk from being spun\-up
442 by periodic \fBsmartd\fP polling. The allowed values of POWERMODE
443 are:
444
445 .I never
446 \- \fBsmartd\fP will poll (check) the device regardless of its power
447 mode. This may cause a disk which is spun\-down to be spun\-up when
448 \fBsmartd\fP checks it. This is the default behavior if the '\-n'
449 Directive is not given.
450
451 .I sleep
452 \- check the device unless it is in SLEEP mode.
453
454 .I standby
455 \- check the device unless it is in SLEEP or STANDBY mode. In
456 these modes most disks are not spinning, so if you want to prevent
457 a laptop disk from spinning up each time that \fBsmartd\fP polls,
458 this is probably what you want.
459
460 .I idle
461 \- check the device unless it is in SLEEP, STANDBY or IDLE mode.
462 In the IDLE state, most disks are still spinning, so this is probably
463 not what you want.
464
465 Maximum number of skipped checks (in a row) can be specified by
466 appending positive number \',N\' to POWERMODE (like \'\-n standby,15\').
467 After N checks are skipped in a row, powermode is ignored and the
468 check is performed anyway.
469
470 When a periodic test is skipped, \fBsmartd\fP normally writes an
471 informal log message. The message can be suppressed by appending
472 the option \',q\' to POWERMODE (like \'\-n standby,q\').
473 This prevents a laptop disk from spinning up due to this message.
474
475 Both \',N\' and \',q\' can be specified together.
476
477 .TP
478 .B \-T TYPE
479 Specifies how tolerant
480 \fBsmartd\fP
481 should be of SMART command failures. The valid arguments to this
482 Directive are:
483
484 .I normal
485 \- do not try to monitor the disk if a mandatory SMART command fails, but
486 continue if an optional SMART command fails. This is the default.
487
488 .I permissive
489 \- try to monitor the disk even if it appears to lack SMART
490 capabilities. This may be required for some old disks (prior to
491 ATA\-3 revision 4) that implemented SMART before the SMART standards
492 were incorporated into the ATA/ATAPI Specifications. This may also be
493 needed for some Maxtor disks which fail to comply with the ATA
494 Specifications and don't properly indicate support for error\- or
495 self\-test logging.
496
497 [Please see the \fBsmartctl \-T\fP command-line option.]
498 .TP
499 .B \-o VALUE
500 Enables or disables SMART Automatic Offline Testing when
501 \fBsmartd\fP
502 starts up and has no further effect. The valid arguments to this
503 Directive are \fIon\fP and \fIoff\fP.
504
505 The delay between tests is vendor-specific, but is typically four
506 hours.
507
508 Note that SMART Automatic Offline Testing is \fBnot\fP part of the ATA
509 Specification. Please see the
510 .B smartctl \-o
511 command-line option documentation for further information about this
512 feature.
513 .TP
514 .B \-S VALUE
515 Enables or disables Attribute Autosave when \fBsmartd\fP
516 starts up and has no further effect. The valid arguments to this
517 Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices.
518 [Please see the \fBsmartctl \-S\fP command-line option.]
519 .TP
520 .B \-H
521 Check the SMART health status of the disk. If any Prefailure
522 Attributes are less than or equal to their threshold values, then disk
523 failure is predicted in less than 24 hours, and a message at loglevel
524 .B \'LOG_CRITICAL\'
525 will be logged to syslog. [Please see the
526 .B smartctl \-H
527 command-line option.]
528 .TP
529 .B \-l TYPE
530 Reports increases in the number of errors in one of the two SMART logs. The
531 valid arguments to this Directive are:
532
533 .I error
534 \- report if the number of ATA errors reported in the ATA Error Log
535 has increased since the last check.
536
537 .I selftest
538 \- report if the number of failed tests reported in the SMART
539 Self-Test Log has increased since the last check, or if the timestamp
540 associated with the most recent failed test has increased. Note that
541 such errors will \fBonly\fP be logged if you run self-tests on the
542 disk (and it fails a test!). Self-Tests can be run automatically by
543 \fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below.
544 Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP
545 and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of
546 the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP
547 command-line option.]
548
549 [Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line
550 options.]
551 .TP
552 .B \-s REGEXP
553 Run Self-Tests or Offline Immediate Tests, at scheduled times. A
554 Self- or Offline Immediate Test will be run at the end of periodic
555 device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP
556 match the extended regular expression \fBREGEXP\fP. Here:
557 .RS 7
558 .IP \fBT\fP 4
559 is the type of the test. The values that \fBsmartd\fP will try to
560 match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a
561 \fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA
562 only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As
563 soon as a match is found, the test will be started and no additional
564 matches will be sought for that device and that polling cycle.
565
566 [NEW EXPERIMENTAL SMARTD FEATURE] To run scheduled Selective
567 Self-Tests, use \'n\' for \fBn\fPext span, \'r\' to \fBr\fPedo last
568 span, or \'c\' to \fBc\fPontinue with next span or redo last span
569 based on status of last test. The LBA range is based on the first
570 span from the last test.
571 See the \fBsmartctl \-t select,[next|redo|cont]\fP options for
572 further info.
573
574 .IP \fBMM\fP 4
575 is the month of the year, expressed with two decimal digits. The
576 range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP
577 use a single decimal digit or the match will always fail!
578 .IP \fBDD\fP 4
579 is the day of the month, expressed with two decimal digits. The
580 range is from 01 to 31 inclusive. Do \fBnot\fP
581 use a single decimal digit or the match will always fail!
582 .IP \fBd\fP 4
583 is the day of the week, expressed with one decimal digit. The
584 range is from 1 (Monday) to 7 (Sunday) inclusive.
585 .IP \fBHH\fP 4
586 is the hour of the day, written with two decimal digits, and given in
587 hours after midnight. The range is 00 (midnight to just before 1am)
588 to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a
589 single decimal digit or the match will always fail!
590 .RE
591 .\" The following two lines are a workaround for a man2html bug. Please leave them.
592 .\" They define a non-existent option; useful because man2html can't correctly reset the margins.
593 .TP
594 .B \&
595 Some examples follow. In reading these, keep in mind that in extended
596 regular expressions a dot \fB\'.\'\fP matches any single character, and
597 a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP,
598 \fBB\fP, or \fBC\fP.
599
600 To schedule a short Self-Test between 2-3am every morning, use:
601 .nf
602 \fB \-s S/../.././02\fP
603 .fi
604 To schedule a long Self-Test between 4-5am every Sunday morning, use:
605 .nf
606 \fB \-s L/../../7/04\fP
607 .fi
608 To schedule a long Self-Test between 10-11pm on the first and
609 fifteenth day of each month, use:
610 .nf
611 \fB \-s L/../(01|15)/./22\fP
612 .fi
613 To schedule an Offline Immediate test after every midnight, 6am,
614 noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long
615 Self-Test every Saturday at 3-4am, use:
616 .nf
617 \fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP
618 .fi
619 If Long Self-Tests of a large disks take longer than the system uptime,
620 a full disk test can be performed by several Selective Self-Tests.
621 To setup a full test of a 1TB disk within 20 days (one 50GB span
622 each day), run this command once:
623 .nf
624 smartctl -t select,0-99999999 /dev/sda
625 .fi
626 To run the next test spans on Monday-Friday between 12-13am, run smartd
627 with this directive:
628 .nf
629 \fB \-s n/../../[1-5]/12\fP
630 .fi
631
632
633 Scheduled tests are run immediately following the regularly-scheduled
634 device polling, if the current local date, time, and test type, match
635 \fBREGEXP\fP. By default the regularly-scheduled device polling
636 occurs every thirty minutes after starting \fBsmartd\fP. Take caution
637 if you use the \'\-i\' option to make this polling interval more than
638 sixty minutes: the poll times may fail to coincide with any of the
639 testing times that you have specified with \fBREGEXP\fP. In this case
640 the test will be run following the next device polling.
641
642 Before running an offline or self-test, \fBsmartd\fP checks to be sure
643 that a self-test is not already running. If a self-test \fBis\fP
644 already running, then this running self test will \fBnot\fP be
645 interrupted to begin another test.
646
647 \fBsmartd\fP will not attempt to run \fBany\fP type of test if another
648 test was already started or run in the same hour.
649
650 To avoid performance problems during system boot, \fBsmartd\fP will
651 not attempt to run any scheduled tests following the very first
652 device polling (unless \'\-q onecheck\' is specified).
653
654 Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG.
655 You can use these or the '-q showtests' command-line option to verify
656 that you constructed \fBREGEXP\fP correctly. The matching order
657 (\fBL\fP before \fBS\fP before \fBC\fP before \fBO\fP) ensures that
658 if multiple test types are all scheduled for the same hour, the
659 longer test type has precedence. This is usually the desired behavior.
660
661 If the scheduled tests are used in conjunction with state persistence
662 (\'\-s\' option), smartd will also try to match the hours since last
663 shutdown (or 90 days at most). If any test would have been started
664 during downtime, the longest (see above) of these tests is run after
665 second device polling.
666
667 If the \'\-n\' directive is used and any test would have been started
668 during disk standby time, the longest of these tests is run when the
669 disk is active again.
670
671 Unix users: please beware that the rules for extended regular
672 expressions [regex(7)] are \fBnot\fP the same as the rules for
673 file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will
674 issue harmless informational warning messages if it detects characters
675 in \fBREGEXP\fP that appear to indicate that you have made this
676 mistake.
677
678 .TP
679 .B \-m ADD
680 Send a warning email to the email address \fBADD\fP if the \'\-H\',
681 \'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a
682 new error, or if a SMART command to the disk fails. This Directive
683 only works in conjunction with these other Directives (or with the
684 equivalent default \'\-a\' Directive).
685
686 To prevent your email in-box from getting filled up with warning
687 messages, by default only a single warning will be sent for each of
688 the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or
689 \'\-O\' even if more than one failure or error is detected or if the
690 failure or error persists. [This behavior can be modified; see the
691 \'\-M\' Directive below.]
692
693 To send email to more than one user, please use the following "comma
694 separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP
695 (with no spaces).
696
697 To test that email is being sent correctly, use the \'\-M test\'
698 Directive described below to send one test email message on
699 \fBsmartd\fP
700 startup.
701
702 By default, email is sent using the system
703 .B mail
704 command. In order that
705 \fBsmartd\fP
706 find the mail command (normally /bin/mail) an executable named
707 .B \'mail\'
708 must be in the path of the shell or environment from which
709 \fBsmartd\fP
710 was started. If you wish to specify an explicit path to the mail
711 executable (for example /usr/local/bin/mail) or a custom script to
712 run, please use the \'\-M exec\' Directive below.
713
714 Note that by default under Solaris, in the previous paragraph,
715 \'\fBmailx\fP\' and \'\fB/bin/mailx\fP\' are used, since Solaris
716 \'/bin/mail\' does not accept a \'\-s\' (Subject) command-line
717 argument.
718
719 On Windows, the \'\fBBlat\fP\' mailer
720 (\fBhttp://blat.sourceforge.net/\fP) is used by default.
721 This mailer uses a different command line syntax, see
722 \'\-M exec\' below.
723
724 Note also that there is a special argument
725 .B <nomailer>
726 which can be given to the \'\-m\' Directive in conjunction with the \'\-M
727 exec\' Directive. Please see below for an explanation of its effect.
728
729 If the mailer or the shell running it produces any STDERR/STDOUT
730 output, then a snippet of that output will be copied to SYSLOG. The
731 remainder of the output is discarded. If problems are encountered in
732 sending mail, this should help you to understand and fix them. If
733 you have mail problems, we recommend running \fBsmartd\fP in debug
734 mode with the \'-d\' flag, using the \'-M test\' Directive described
735 below.
736
737 The following extension is available on Windows:
738 By specifying \'\fBmsgbox\fP\' as a mail address, a warning
739 "email" is displayed as a message box on the screen.
740 Using both \'\fBmsgbox\fP\' and regular mail addresses is possible,
741 if \'\fBmsgbox\fP\' is the first word in the comma separated list.
742 With \'\fBsysmsgbox\fP\', a system modal (always on top) message box
743 is used. If running as a service, a service notification message box
744 (always shown on current visible desktop) is used.
745
746 .TP
747 .B \-M TYPE
748 These Directives modify the behavior of the
749 \fBsmartd\fP
750 email warnings enabled with the \'\-m\' email Directive described above.
751 These \'\-M\' Directives only work in conjunction with the \'\-m\'
752 Directive and can not be used without it.
753
754 Multiple \-M Directives may be given. If more than one of the
755 following three \-M Directives are given (example: \-M once \-M daily)
756 then the final one (in the example, \-M daily) is used.
757
758 The valid arguments to the \-M Directive are (one of the following
759 three):
760
761 .I once
762 \- send only one warning email for each type of disk problem detected. This
763 is the default.
764
765 .I daily
766 \- send additional warning reminder emails, once per day, for each type
767 of disk problem detected.
768
769 .I diminishing
770 \- send additional warning reminder emails, after a one-day interval,
771 then a two-day interval, then a four-day interval, and so on for each
772 type of disk problem detected. Each interval is twice as long as the
773 previous interval.
774
775 In addition, one may add zero or more of the following Directives:
776
777 .I test
778 \- send a single test email
779 immediately upon
780 \fBsmartd\fP
781 startup. This allows one to verify that email is delivered correctly.
782 Note that if this Directive is used,
783 \fBsmartd\fP
784 will also send the normal email warnings that were enabled with the \'\-m\' Directive,
785 in addition to the single test email!
786
787 .I exec PATH
788 \- run the executable PATH instead of the default mail command, when
789 \fBsmartd\fP
790 needs to send email. PATH must point to an executable binary file or
791 script.
792
793 By setting PATH to point to a customized script, you can make
794 \fBsmartd\fP perform useful tricks when a disk problem is detected
795 (beeping the console, shutting down the machine, broadcasting warnings
796 to all logged-in users, etc.) But please be careful. \fBsmartd\fP
797 will \fBblock\fP until the executable PATH returns, so if your
798 executable hangs, then \fBsmartd\fP will also hang. Some sample
799 scripts are included in
800 /usr/local/share/doc/smartmontools-5.1/examplescripts/.
801
802 The return status of the executable is recorded by \fBsmartd\fP in
803 SYSLOG. The executable is not expected to write to STDOUT or
804 STDERR. If it does, then this is interpreted as indicating that
805 something is going wrong with your executable, and a fragment of this
806 output is logged to SYSLOG to help you to understand the problem.
807 Normally, if you wish to leave some record behind, the executable
808 should send mail or write to a file or device.
809
810 Before running the executable, \fBsmartd\fP sets a number of
811 environment variables. These environment variables may be used to
812 control the executable\'s behavior. The environment variables
813 exported by \fBsmartd\fP are:
814 .RS 7
815 .IP \fBSMARTD_MAILER\fP 4
816 is set to the argument of \-M exec, if present or else to \'mail\'
817 (examples: /bin/mail, mail).
818 .IP \fBSMARTD_DEVICE\fP 4
819 is set to the device path (examples: /dev/hda, /dev/sdb).
820 .IP \fBSMARTD_DEVICETYPE\fP 4
821 is set to the device type (possible values: ata, scsi, 3ware,N,
822 areca,N, hpt,L/M/N). Here N=0,...,127 denotes the ATA disk behind a
823 3ware RAID controller and L/M/N denotes the SATA disk behind a
824 HighPoint RocketRAID controller.
825 .IP \fBSMARTD_DEVICESTRING\fP 4
826 is set to the device description. For SMARTD_DEVICETYPE of ata or
827 scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers,
828 the form used is \'/dev/sdc [3ware_disk_01]\'. For HighPoint
829 RocketRAID controller, the form is \'/dev/sdd [hpt_1/1/1]\' under Linux
830 or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Areca controllers, the
831 form is \'/dev/sg2 [areca_disk_09]\'. In these cases the device string
832 contains a space and is NOT quoted. So to use $SMARTD_DEVICESTRING in a
833 bash script you should probably enclose it in double quotes.
834 .IP \fBSMARTD_FAILTYPE\fP 4
835 gives the reason for the warning or message email. The possible values that
836 it takes and their meanings are:
837 .nf
838 .fi
839 \fIEmailTest\fP: this is an email test message.
840 .nf
841 .fi
842 \fIHealth\fP: the SMART health status indicates imminent failure.
843 .nf
844 .fi
845 \fIUsage\fP: a usage Attribute has failed.
846 .nf
847 .fi
848 \fISelfTest\fP: the number of self-test failures has increased.
849 .nf
850 .fi
851 \fIErrorCount\fP: the number of errors in the ATA error log has increased.
852 .nf
853 .fi
854 \fICurrentPendingSector\fP: one of more disk sectors could not be
855 read and are marked to be reallocated (replaced with spare sectors).
856 .nf
857 .fi
858 \fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing,
859 one or more disk sectors could not be read.
860 .nf
861 .fi
862 \fIFailedHealthCheck\fP: the SMART health status command failed.
863 .nf
864 .fi
865 \fIFailedReadSmartData\fP: the command to read SMART Attribute data failed.
866 .nf
867 .fi
868 \fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed.
869 .nf
870 .fi
871 \fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed.
872 .nf
873 .fi
874 \fIFailedOpenDevice\fP: the open() command to the device failed.
875 .IP \fBSMARTD_ADDRESS\fP 4
876 is determined by the address argument ADD of the \'\-m\' Directive.
877 If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set.
878 Otherwise, it is set to the comma-separated-list of email addresses
879 given by the argument ADD, with the commas replaced by spaces
880 (example:admin@example.com root). If more than one email address is
881 given, then this string will contain space characters and is NOT
882 quoted, so to use it in a bash script you may want to enclose it in
883 double quotes.
884 .IP \fBSMARTD_MESSAGE\fP 4
885 is set to the one sentence summary warning email message string from
886 \fBsmartd\fP.
887 This message string contains space characters and is NOT quoted. So to
888 use $SMARTD_MESSAGE in a bash script you should probably enclose it in
889 double quotes.
890 .IP \fBSMARTD_FULLMESSAGE\fP 4
891 is set to the contents of the entire email warning message string from
892 \fBsmartd\fP.
893 This message string contains space and return characters and is NOT quoted. So to
894 use $SMARTD_FULLMESSAGE in a bash script you should probably enclose it in
895 double quotes.
896 .IP \fBSMARTD_TFIRST\fP 4
897 is a text string giving the time and date at which the first problem
898 of this type was reported. This text string contains space characters
899 and no newlines, and is NOT quoted. For example:
900 .nf
901 .fi
902 Sun Feb 9 14:58:19 2003 CST
903 .IP \fBSMARTD_TFIRSTEPOCH\fP 4
904 is an integer, which is the unix epoch (number of seconds since Jan 1,
905 1970) for \fBSMARTD_TFIRST\fP.
906 .RE
907 .\" The following two lines are a workaround for a man2html bug. Please leave them.
908 .\" They define a non-existent option; useful because man2html can't correctly reset the margins.
909 .TP
910 .B \&
911 The shell which is used to run PATH is system-dependent. For vanilla
912 Linux/glibc it\'s bash. For other systems, the man page for
913 \fBpopen\fP(3) should say what shell is used.
914
915 If the \'\-m ADD\' Directive is given with a normal address argument,
916 then the executable pointed to by PATH will be run in a shell with
917 STDIN receiving the body of the email message, and with the same
918 command-line arguments:
919 .nf
920 -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS
921 .fi
922 that would normally be provided to \'mail\'. Examples include:
923 .nf
924 .B -m user@home -M exec /bin/mail
925 .B -m admin@work -M exec /usr/local/bin/mailto
926 .B -m root -M exec /Example_1/bash/script/below
927 .fi
928
929 Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is
930 used:
931 .nf
932 - -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS"
933 .fi
934
935 If the \'\-m ADD\' Directive is given with the special address argument
936 .B <nomailer>
937 then the executable pointed to by PATH is run in a shell with
938 .B no
939 STDIN and
940 .B no
941 command-line arguments, for example:
942 .nf
943 .B -m <nomailer> -M exec /Example_2/bash/script/below
944 .fi
945 If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP
946 assumes that something is going wrong, and a snippet of that output
947 will be copied to SYSLOG. The remainder of the output is then
948 discarded.
949
950 Some EXAMPLES of scripts that can be used with the \'\-M exec\'
951 Directive are given below. Some sample scripts are also included in
952 /usr/local/share/doc/smartmontools-5.1/examplescripts/.
953
954 .TP
955 .B \-f
956 Check for \'failure\' of any Usage Attributes. If these Attributes are
957 less than or equal to the threshold, it does NOT indicate imminent
958 disk failure. It "indicates an advisory condition where the usage or
959 age of the device has exceeded its intended design life period."
960 [Please see the \fBsmartctl \-A\fP command-line option.]
961 .TP
962 .B \-p
963 Report anytime that a Prefail Attribute has changed
964 its value since the last check, 30 minutes ago. [Please see the
965 .B smartctl \-A
966 command-line option.]
967 .TP
968 .B \-u
969 Report anytime that a Usage Attribute has changed its value
970 since the last check, 30 minutes ago. [Please see the
971 .B smartctl \-A
972 command-line option.]
973 .TP
974 .B \-t
975 Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
976 Tracks changes in \fIall\fP device Attributes (both Prefailure and
977 Usage). [Please see the \fBsmartctl\fP \-A command-line option.]
978 .TP
979 .B \-i ID
980 Ignore device Attribute number \fBID\fP when checking for failure of
981 Usage Attributes. \fBID\fP must be a decimal integer in the range
982 from 1 to 255. This Directive modifies the behavior of the \'\-f\'
983 Directive and has no effect without it.
984
985 This is useful, for example, if you have a very old disk and don\'t
986 want to keep getting messages about the hours-on-lifetime Attribute
987 (usually Attribute 9) failing. This Directive may appear multiple
988 times for a single device, if you want to ignore multiple Attributes.
989 .TP
990 .B \-I ID
991 Ignore device Attribute \fBID\fP when tracking changes in the
992 Attribute values. \fBID\fP must be a decimal integer in the range
993 from 1 to 255. This Directive modifies the behavior of the \'\-p\',
994 \'\-u\', and \'\-t\' tracking Directives and has no effect without one
995 of them.
996
997 This is useful, for example, if one of the device Attributes is the disk
998 temperature (usually Attribute 194 or 231). It\'s annoying to get reports
999 each time the temperature changes. This Directive may appear multiple
1000 times for a single device, if you want to ignore multiple Attributes.
1001 .TP
1002 .B \-r ID[!]
1003 When tracking, report the \fIRaw\fP value of Attribute \fBID\fP along
1004 with its (normally reported) \fINormalized\fP value. \fBID\fP must be
1005 a decimal integer in the range from 1 to 255. This Directive modifies
1006 the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives
1007 and has no effect without one of them. This Directive may be given
1008 multiple times.
1009
1010 A common use of this Directive is to track the device Temperature
1011 (often ID=194 or 231).
1012
1013 If the optional flag \'!\' is appended, a change of the Normalized
1014 value is considered critical. The report will be logged as LOG_CRIT
1015 and a warning email will be sent if \'-m\' is specified.
1016
1017 .TP
1018 .B \-R ID[!]
1019 When tracking, report whenever the \fIRaw\fP value of Attribute
1020 \fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes
1021 of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal
1022 integer in the range from 1 to 255. This Directive modifies the
1023 behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and
1024 has no effect without one of them. This Directive may be given
1025 multiple times.
1026
1027 If this Directive is given, it automatically implies the \'\-r\'
1028 Directive for the same Attribute, so that the Raw value of the
1029 Attribute is reported.
1030
1031 A common use of this Directive is to track the device Temperature
1032 (often ID=194 or 231). It is also useful for understanding how
1033 different types of system behavior affects the values of certain
1034 Attributes.
1035
1036 If the optional flag \'!\' is appended, a change of the Raw
1037 value is considered critical. The report will be logged as
1038 LOG_CRIT and a warning email will be sent if \'-m\' is specified.
1039 An example is \'-R 5!\' to warn when new sectors are reallocated.
1040
1041 .TP
1042 .B \-C ID[+]
1043 [ATA only] Report if the current number of pending sectors is
1044 non-zero. Here \fBID\fP is the id number of the Attribute whose raw
1045 value is the Current Pending Sector count. The allowed range of
1046 \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
1047 ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to
1048 \fB\-C 197\fP (since Attribute 197 is generally used to monitor
1049 pending sectors).
1050
1051 If \'+\' is specified, a report is only printed if the number of sectors
1052 has increased between two check cycles. Some disks do not reset this
1053 attribute when a bad sector is reallocated.
1054 See also \'\-v 197,increasing\' below.
1055
1056 A pending sector is a disk sector (containing 512 bytes of your data)
1057 which the device would like to mark as ``bad" and reallocate.
1058 Typically this is because your computer tried to read that sector, and
1059 the read failed because the data on it has been corrupted and has
1060 inconsistent Error Checking and Correction (ECC) codes. This is
1061 important to know, because it means that there is some unreadable data
1062 on the disk. The problem of figuring out what file this data belongs
1063 to is operating system and file system specific. You can typically
1064 force the sector to reallocate by writing to it (translation: make the
1065 device substitute a spare good sector for the bad one) but at the
1066 price of losing the 512 bytes of data stored there.
1067
1068 .TP
1069 .B \-U ID[+]
1070 [ATA only] Report if the number of offline uncorrectable sectors is
1071 non-zero. Here \fBID\fP is the id number of the Attribute whose raw
1072 value is the Offline Uncorrectable Sector count. The allowed range of
1073 \fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
1074 ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to
1075 \fB\-U 198\fP (since Attribute 198 is generally used to monitor
1076 offline uncorrectable sectors).
1077
1078 If \'+\' is specified, a report is only printed if the number of sectors
1079 has increased since the last check cycle. Some disks do not reset this
1080 attribute when a bad sector is reallocated.
1081 See also \'\-v 198,increasing\' below.
1082
1083 An offline uncorrectable sector is a disk sector which was not
1084 readable during an off\-line scan or a self\-test. This is important
1085 to know, because if you have data stored in this disk sector, and you
1086 need to read it, the read will fail. Please see the previous \'\-C\'
1087 option for more details.
1088
1089 .TP
1090 .B \-W DIFF[,INFO[,CRIT]]
1091 Report if the current temperature had changed by at least \fBDIFF\fP
1092 degrees since last report, or if new min or max temperature is detected.
1093 Report or Warn if the temperature is greater or equal than one of
1094 \fBINFO\fP or \fBCRIT\fP degrees Celsius.
1095 If the limit \fBCRIT\fP is reached, a message with loglevel
1096 \fB\'LOG_CRITICAL\'\fP will be logged to syslog and a warning email
1097 will be send if '-m' is specified. If only the limit \fBINFO\fP is
1098 reached, a message with loglevel \fB\'LOG_INFO\'\fP will be logged.
1099
1100 If this directive is used in conjunction with state persistence
1101 (\'\-s\' option), the min and max temperature values are preserved
1102 across boot cycles. The minimum temperature value is not updated
1103 during the first 30 minutes after startup.
1104
1105 To disable any of the 3 reports, set the corresponding limit to 0.
1106 Trailing zero arguments may be omitted. By default, all temperature
1107 reports are disabled (\'-W 0\').
1108
1109 To track temperature changes of at least 2 degrees, use:
1110 .nf
1111 \fB \-W 2
1112 .fi
1113 To log informal messages on temperatures of at least 40 degrees, use:
1114 .nf
1115 \fB \-W 0,40
1116 .fi
1117 For warning messages/mails on temperatures of at least 45 degrees, use:
1118 .nf
1119 \fB \-W 0,0,45
1120 .fi
1121 To combine all of the above reports, use:
1122 .nf
1123 \fB \-W 2,40,45
1124 .fi
1125
1126 For ATA devices, smartd interprets Attribute 194 as Temperature Celsius
1127 by default. This can be changed to Attribute 9 or 220 by the drive
1128 database or by the \'-v\' directive, see below.
1129
1130 .TP
1131 .B \-F TYPE
1132 [ATA only] Modifies the behavior of \fBsmartd\fP to compensate for
1133 some known and understood device firmware bug. The arguments to this
1134 Directive are exclusive, so that only the final Directive given is
1135 used. The valid values are:
1136
1137 .I none
1138 \- Assume that the device firmware obeys the ATA specifications. This is
1139 the default, unless the device has presets for \'\-F\' in the device
1140 database.
1141
1142 .I samsung
1143 \- In some Samsung disks (example: model SV4012H Firmware Version:
1144 RM100-08) some of the two- and four-byte quantities in the SMART data
1145 structures are byte-swapped (relative to the ATA specification).
1146 Enabling this option tells \fBsmartd\fP to evaluate these quantities
1147 in byte-reversed order. Some signs that your disk needs this option
1148 are (1) no self-test log printed, even though you have run self-tests;
1149 (2) very large numbers of ATA errors reported in the ATA error log;
1150 (3) strange and impossible values for the ATA error log timestamps.
1151
1152 .I samsung2
1153 \- In more recent Samsung disks (firmware revisions ending in "\-23") the
1154 number of ATA errors reported is byte swapped. Enabling this option
1155 tells \fBsmartd\fP to evaluate this quantity in byte-reversed order.
1156
1157 .I samsung3
1158 \- Some Samsung disks (at least SP2514N with Firmware VF100\-37) report
1159 a self\-test still in progress with 0% remaining when the test was already
1160 completed. If this directive is specified, \fBsmartd\fP will not skip the
1161 next scheduled self\-test (see Directive \'\-s\' above) in this case.
1162
1163 Note that an explicit \'\-F\' Directive will over-ride any preset
1164 values for \'\-F\' (see the \'\-P\' option below).
1165
1166
1167 [Please see the \fBsmartctl \-F\fP command-line option.]
1168
1169 .TP
1170 .B \-v ID,FORMAT[:BYTEORDER][,NAME]
1171 [ATA only] Sets a vendor\-specific raw value print FORMAT, an optional
1172 BYTEORDER and an optional NAME for Attribute ID.
1173 This directive may be used multiple times.
1174 Please see \fBsmartctl -v\fP command-line option for further details.
1175
1176 The following arguments affect smartd warning output:
1177
1178 .I 197,increasing
1179 \- Raw Attribute number 197 (Current Pending Sector Count) is not
1180 reset if uncorrectable sectors are reallocated. This sets \'-C 197+\'
1181 if no other \'-C\' directive is specified.
1182
1183 .I 198,increasing
1184 \- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not
1185 reset if uncorrectable sector are reallocated. This sets \'-U 198+\'
1186 if no other \'-U\' directive is specified.
1187
1188 .TP
1189 .B \-P TYPE
1190 Specifies whether
1191 \fBsmartd\fP
1192 should use any preset options that are available for this drive. The
1193 valid arguments to this Directive are:
1194
1195 .I use
1196 \- use any presets that are available for this drive. This is the default.
1197
1198 .I ignore
1199 \- do not use any presets for this drive.
1200
1201 .I show
1202 \- show the presets listed for this drive in the database.
1203
1204 .I showall
1205 \- show the presets that are available for all drives and then exit.
1206
1207 [Please see the
1208 .B smartctl \-P
1209 command-line option.]
1210
1211 .TP
1212 .B \-a
1213 Equivalent to turning on all of the following Directives:
1214 .B \'\-H\'
1215 to check the SMART health status,
1216 .B \'\-f\'
1217 to report failures of Usage (rather than Prefail) Attributes,
1218 .B \'\-t\'
1219 to track changes in both Prefailure and Usage Attributes,
1220 .B \'\-l\ selftest\'
1221 to report increases in the number of Self-Test Log errors,
1222 .B \'\-l\ error\'
1223 to report increases in the number of ATA errors,
1224 .B \'\-C 197\'
1225 to report nonzero values of the current pending sector count, and
1226 .B \'\-U 198\'
1227 to report nonzero values of the offline pending sector count.
1228
1229 Note that \-a is the default for ATA devices. If none of these other
1230 Directives is given, then \-a is assumed.
1231
1232 .TP
1233 .B #
1234 Comment: ignore the remainder of the line.
1235 .TP
1236 .B \e
1237 Continuation character: if this is the last non-white or non-comment
1238 character on a line, then the following line is a continuation of the current
1239 one.
1240 .PP
1241 If you are not sure which Directives to use, I suggest experimenting
1242 for a few minutes with
1243 .B smartctl
1244 to see what SMART functionality your disk(s) support(s). If you do
1245 not like voluminous syslog messages, a good choice of
1246 \fBsmartd\fP
1247 configuration file Directives might be:
1248 .nf
1249 .B \-H \-l\ selftest \-l\ error \-f.
1250 .fi
1251 If you want more frequent information, use:
1252 .B -a.
1253
1254 .TP
1255 .B ADDITIONAL DETAILS ABOUT DEVICESCAN
1256 If the first non-comment entry in the configuration file is the text
1257 string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will
1258 ignore any remaining lines in the configuration file, and will scan
1259 for devices.
1260
1261 If \fBDEVICESCAN\fP is not followed by any Directives, then smartd
1262 will scan for both ATA and SCSI devices, and will monitor all possible
1263 SMART properties of any devices that are found.
1264
1265 \fBDEVICESCAN\fP may optionally be followed by any valid Directives,
1266 which will be applied to all devices that are found in the scan. For
1267 example
1268 .nf
1269 .B DEVICESCAN -m root@example.com
1270 .fi
1271 will scan for all devices, and then monitor them. It will send one
1272 email warning per device for any problems that are found.
1273 .nf
1274 .B DEVICESCAN -d ata -m root@example.com
1275 .fi
1276 will do the same, but restricts the scan to ATA devices only.
1277 .nf
1278 .B DEVICESCAN -H -d ata -m root@example.com
1279 .fi
1280 will do the same, but only monitors the SMART health status of the
1281 devices, (rather than the default \-a, which monitors all SMART
1282 properties).
1283
1284 .TP
1285 .B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\'
1286 These are two examples of shell scripts that can be used with the \'\-M
1287 exec PATH\' Directive described previously. The paths to these scripts
1288 and similar executables is the PATH argument to the \'\-M exec PATH\'
1289 Directive.
1290
1291 Example 1: This script is for use with \'\-m ADDRESS -M exec PATH\'. It appends
1292 the output of
1293 .B smartctl -a
1294 to the output of the smartd email warning message and sends it to ADDRESS.
1295
1296 .nf
1297 \fB
1298 #! /bin/bash
1299
1300 # Save the email message (STDIN) to a file:
1301 cat > /root/msg
1302
1303 # Append the output of smartctl -a to the message:
1304 /usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
1305
1306 # Now email the message to the user at address ADD:
1307 /bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
1308 \fP
1309 .fi
1310
1311 Example 2: This script is for use with \'\-m <nomailer> \-M exec
1312 PATH\'. It warns all users about a disk problem, waits 30 seconds, and
1313 then powers down the machine.
1314
1315 .nf
1316 \fB
1317 #! /bin/bash
1318
1319 # Warn all users of a problem
1320 wall \'Problem detected with disk: \' "$SMARTD_DEVICESTRING"
1321 wall \'Warning message from smartd is: \' "$SMARTD_MESSAGE"
1322 wall \'Shutting down machine in 30 seconds... \'
1323
1324 # Wait half a minute
1325 sleep 30
1326
1327 # Power down the machine
1328 /sbin/shutdown -hf now
1329 \fP
1330 .fi
1331
1332 Some example scripts are distributed with the smartmontools package,
1333 in /usr/local/share/doc/smartmontools-5.1/examplescripts/.
1334
1335 Please note that these scripts typically run as root, so any files
1336 that they read/write should not be writable by ordinary users or
1337 reside in directories like /tmp that are writable by ordinary users
1338 and may expose your system to symlink attacks.
1339
1340 As previously described, if the scripts write to STDOUT or STDERR,
1341 this is interpreted as indicating that there was an internal error
1342 within the script, and a snippet of STDOUT/STDERR is logged to SYSLOG.
1343 The remainder is flushed.
1344
1345 .\" ENDINCLUDE
1346 .\" DO NOT MODIFY THIS OR PREVIOUS/NEXT LINES. THIS DEFINES THE
1347 .\" END OF THE INCLUDED SECTION FROM smartd.8.in
1348
1349 .PP
1350 .SH AUTHOR
1351 \fBBruce Allen\fP smartmontools-support@lists.sourceforge.net
1352 .fi
1353 University of Wisconsin \- Milwaukee Physics Department
1354
1355 .PP
1356 .SH CONTRIBUTORS
1357 The following have made large contributions to smartmontools:
1358 .nf
1359 \fBCasper Dik\fP (Solaris SCSI interface)
1360 \fBChristian Franke\fP (Windows interface, C++ redesign, USB support, ...)
1361 \fBDouglas Gilbert\fP (SCSI subsystem)
1362 \fBGuido Guenther\fP (Autoconf/Automake packaging)
1363 \fBGeoffrey Keating\fP (Darwin ATA interface)
1364 \fBEduard Martinescu\fP (FreeBSD interface)
1365 \fBFr\*'ed\*'eric L. W. Meunier\fP (Web site and Mailing list)
1366 \fBGabriele Pohl\fP (Web site and Wiki, conversion from CVS to SVN)
1367 \fBKeiji Sawada\fP (Solaris ATA interface)
1368 \fBManfred Schwarb\fP (Drive database)
1369 \fBSergey Svishchev\fP (NetBSD interface)
1370 \fBDavid Snyder and Sergey Svishchev\fP (OpenBSD interface)
1371 \fBPhil Williams\fP (User interface and drive database)
1372 \fBShengfeng Zhou\fP (Linux/FreeBSD HighPoint RocketRAID interface)
1373 .fi
1374 Many other individuals have made smaller contributions and corrections.
1375
1376 .PP
1377 .SH CREDITS
1378 .fi
1379 This code was derived from the smartsuite package, written by Michael
1380 Cornwell, and from the previous ucsc smartsuite package. It extends
1381 these to cover ATA-5 disks. This code was originally developed as a
1382 Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory
1383 (now part of the Storage Systems Research Center), Jack Baskin School
1384 of Engineering, University of California, Santa
1385 Cruz. \fBhttp://ssrc.soe.ucsc.edu/\fP .
1386 .SH
1387 HOME PAGE FOR SMARTMONTOOLS:
1388 .fi
1389 Please see the following web site for updates, further documentation, bug
1390 reports and patches:
1391 .nf
1392 .B
1393 http://smartmontools.sourceforge.net/
1394
1395 .SH
1396 SEE ALSO:
1397 \fBsmartd\fP(8), \fBsmartctl\fP(8), \fBsyslogd\fP(8),
1398 \fBsyslog.conf\fP(5), \fBbadblocks\fP(8), \fBide\-smart\fP(8), \fBregex\fP(7).
1399
1400 .SH
1401 SVN ID OF THIS PAGE:
1402 $Id: smartd.conf.5.in 3001 2009-12-19 15:25:27Z chrfranke $