1SMARTD.CONF(5) SMART Monitoring Tools SMARTD.CONF(5)
2
3
4
6 smartd.conf - SMART Disk Monitoring Daemon Configuration File
7
8
10 [This man page is generated for the Linux version of smartmontools. It
11 does not contain info specific to other platforms.]
12
13 /etc/smartmontools/smartd.conf is the configuration file for the smartd
14 daemon.
15
16 If the configuration file /etc/smartmontools/smartd.conf is present,
17 smartd reads it at startup. If smartd subsequently receives a HUP sig‐
18 nal, it will then re-read the configuration file. If smartd is running
19 in debug mode, then an INT signal will also make it re-read the config‐
20 uration file. This signal can be generated by typing <CONTROL-C> in
21 the terminal window where smartd is running.
22
23 In the absence of a configuration file smartd will try to open all
24 available devices (see smartd(8) man page). A configuration file with
25 a single line 'DEVICESCAN -a' would have the same effect.
26
27 This can be annoying if you have an ATA or SCSI device that hangs or
28 misbehaves when receiving SMART commands. Even if this causes no prob‐
29 lems, you may be annoyed by the string of error log messages about de‐
30 vices that can't be opened.
31
32 One can avoid this problem, and gain more control over the types of
33 events monitored by smartd, by using the configuration file /etc/smart‐
34 montools/smartd.conf. This file contains a list of devices to monitor,
35 with one device per line. An example file is included with the smart‐
36 montools distribution. You will find this sample configuration file in
37 /usr/share/doc/smartmontools/. For security, the configuration file
38 should not be writable by anyone but root. The syntax of the file is
39 as follows:
40
41 • There should be one device listed per line, although you may have
42 lines that are entirely comments or white space.
43
44 • Any text following a hash sign '#' and up to the end of the line is
45 taken to be a comment, and ignored.
46
47 • Lines may be continued by using a backslash '\' as the last non-
48 whitespace or non-comment item on a line.
49
50 • Note: a line whose first character is a hash sign '#' is treated as
51 a white-space blank line, not as a non-existent line, and will end
52 a continuation line.
53
54 Here is an example configuration file. It's for illustrative purposes
55 only; please don't copy it onto your system without reading to the end
56 of the DIRECTIVES Section below!
57
58 ################################################
59 # This is an example smartd startup config file
60 # /etc/smartmontools/smartd.conf
61 #
62 # On the second disk, start a long self-test every
63 # Sunday between 3 and 4 am.
64 #
65 /dev/sda -a -m admin@example.com,root@localhost
66 /dev/sdb -a -I 194 -I 5 -i 12 -s L/../../7/03
67 #
68 # Send a TEST warning email to admin on startup.
69 #
70 /dev/sdc -m admin@example.com -M test
71 #
72 # Strange device. It's SCSI. Start a scheduled
73 # long self test between 5 and 6 am Monday/Thursday
74 /dev/weird -d scsi -s L/../../(1|4)/05
75 #
76 # An ATA disk may appear as a SCSI device to the
77 # OS. If a SCSI to ATA Translation (SAT) layer
78 # is between the OS and the device then this can be
79 # flagged with the '-d sat' option. This situation
80 # may become common with SATA disks in SAS and FC
81 # environments.
82 /dev/sda -a -d sat
83 #
84 # Disks connected to a MegaRAID controller
85 # Start short self-tests daily between 1-2, 2-3, and
86 # 3-4 am.
87 # Linux:
88 /dev/sda -d megaraid,0 -a -s S/../.././01
89 /dev/sda -d megaraid,1 -a -s S/../.././02
90 /dev/sda -d megaraid,2 -a -s S/../.././03
91 /dev/bus/0 -d megaraid,2 -a -s S/../.././03
92 #
93 # Three disks connected to an AacRaid controller
94 # Start short self-tests daily between 1-2, 2-3, and
95 # 3-4 am.
96 /dev/sda -d aacraid,0,0,66 -a -s S/../.././01
97 /dev/sda -d aacraid,0,0,67 -a -s S/../.././02
98 /dev/sda -d aacraid,0,0,68 -a -s S/../.././03
99 #
100 # Two SATA (not SAS) disks on a 3ware 9750 controller.
101 # Start long self-tests Sundays between midnight and
102 # 1 am and 2-3 am
103 # under Linux
104 /dev/twl0 -d 3ware,0 -a -s L/../../7/00
105 /dev/twl0 -d 3ware,1 -a -s L/../../7/02
106 #
107 # Three SATA disks on a HighPoint RocketRAID controller.
108 # Start short self-tests daily between 1-2, 2-3, and
109 # 3-4 am.
110 # under Linux
111 /dev/sde -d hpt,1/1 -a -s S/../.././01
112 /dev/sde -d hpt,1/2 -a -s S/../.././02
113 /dev/sde -d hpt,1/3 -a -s S/../.././03
114 #
115 # Two SATA disks connected to a HighPoint RocketRAID
116 # via a pmport device. Start long self-tests Sundays
117 # between midnight and 1 am and 2-3 am.
118 # under Linux
119 /dev/sde -d hpt,1/4/1 -a -s L/../../7/00
120 /dev/sde -d hpt,1/4/2 -a -s L/../../7/02
121 #
122 # Three SATA disks connected to an Areca
123 # RAID controller. Start long self-tests Sundays
124 # between midnight and 3 am.
125 # under Linux
126 /dev/sg2 -d areca,1 -a -s L/../../7/00
127 /dev/sg2 -d areca,2 -a -s L/../../7/01
128 /dev/sg2 -d areca,3 -a -s L/../../7/02
129 #
130 # Two SATA disks on an Intelliprop controller.
131 # Start short self-tests daily between 1-2, 2-3, and
132 # 3-4 am.
133 /dev/sde -d intelliprop,0+sat -a -s S/../.././01
134 /dev/sde -d intelliprop,1+sat -a -s S/../.././02
135 #
136 # The following line enables monitoring of the
137 # ATA Error Log and the Self-Test Error Log.
138 # It also tracks changes in both Prefailure
139 # and Usage Attributes, apart from Attributes
140 # 9, 194, and 231, and shows continued lines:
141 #
142 /dev/sdd -l error \
143 -l selftest \
144 -t \ # Attributes not tracked:
145 -I 194 \ # temperature
146 -I 231 \ # also temperature
147 -I 9 # power-on hours
148 #
149 ################################################
150
151
153 If a non-comment entry in the configuration file is the text string DE‐
154 VICESCAN in capital letters, then smartd will ignore any remaining
155 lines in the configuration file, and will scan for devices. If DE‐
156 VICESCAN is not followed by any Directives, then '-a' will apply to all
157 devices.
158
159 DEVICESCAN may optionally be followed by Directives that will apply to
160 all devices that are found in the scan. For example
161
162 DEVICESCAN -m root@example.com
163
164 will scan for all devices, and then monitor them. It will send one
165 email warning per device for any problems that are found.
166
167 DEVICESCAN -H -m root@example.com
168
169 will do the same, but only monitors the SMART health status of the de‐
170 vices, rather than the default '-a'.
171
172 Multiple '-d TYPE' options may be specified with DEVICESCAN to combine
173 the scan results of more than one TYPE.
174
175 Configuration entries for specific devices may precede the DEVICESCAN
176 entry. For example
177
178 DEFAULT -m root@example.com
179 /dev/sda -s S/../.././02
180 /dev/sdc -d ignore
181 DEVICESCAN -s L/../.././02
182
183 will scan for all devices except /dev/sda and /dev/sdc, monitor them,
184 and run a long test between 2–3 am every morning. Device /dev/sda will
185 also be monitored, but only a short test will be run. Device /dev/sdc
186 will be ignored. Warning emails will be sent for all monitored de‐
187 vices.
188
189 A device is ignored by DEVICESCAN if a configuration line with the same
190 device name exists.
191 [NEW EXPERIMENTAL SMARTD FEATURE] Symbolic links are resolved before
192 this check is done.
193
194 A device name is also ignored if another device with same identify in‐
195 formation (vendor, model, firmware version, serial number, WWN) already
196 exists.
197
198
200 If an entry in the configuration file starts with DEFAULT instead of a
201 device name, then all directives in this entry are set as defaults for
202 the next device entries.
203
204 This configuration:
205
206 DEFAULT -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
207 /dev/sda
208 /dev/sdb
209 /dev/sdc
210 DEFAULT -H -m admin@example.com
211 /dev/sdd
212 /dev/sde -d removable
213
214 has the same effect as:
215
216 /dev/sda -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
217 /dev/sdb -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
218 /dev/sdc -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
219 /dev/sdd -H -m admin@example.com
220 /dev/sde -d removable -H -m admin@example.com
221
222
224 The following are the Directives that may appear following the device
225 name or DEVICESCAN or DEFAULT on any line of the /etc/smartmon‐
226 tools/smartd.conf configuration file. Note that these are NOT command-
227 line options for smartd. The Directives below may appear in any order,
228 following the device name.
229
230 For an ATA device, if no Directives appear, then the device will be
231 monitored as if the '-a' Directive (monitor all SMART properties) had
232 been given.
233
234 If a SCSI disk is listed, it will be monitored at the maximum imple‐
235 mented level: roughly equivalent to using the '-H -l selftest' options
236 for an ATA disk. So with the exception of '-d', '-m', '-l selftest',
237 '-s', and '-M', the Directives below are ignored for SCSI disks. For
238 SCSI disks, the '-m' Directive sends a warning email if the SMART sta‐
239 tus indicates a disk failure or problem, if the SCSI inquiry about disk
240 status fails, or if new errors appear in the self-test log.
241
242 If a 3ware controller is used then the corresponding SCSI (/dev/sd?) or
243 character device (/dev/twe?, /dev/twa?, /dev/twl? or /dev/tws?) must be
244 listed, along with the '-d 3ware,N' Directive (see below). The indi‐
245 vidual ATA disks hosted by the 3ware controller appear to smartd as
246 normal ATA devices. Hence all the ATA directives can be used for these
247 disks (but see note below).
248
249 If an Areca controller is used then the corresponding device (SCSI
250 /dev/sg? on Linux or /dev/arcmsr0 on FreeBSD) must be listed, along
251 with the '-d areca,N' Directive (see below). The individual SATA disks
252 hosted by the Areca controller appear to smartd as normal ATA devices.
253 Hence all the ATA directives can be used for these disks. Areca
254 firmware version 1.46 or later which supports smartmontools must be
255 used; Please see the smartctl(8) man page for further details.
256
257 -d TYPE
258 Specifies the type of the device. The valid arguments to this
259 directive are:
260
261 auto - attempt to guess the device type from the device name or
262 from controller type info provided by the operating system or
263 from a matching USB ID entry in the drive database. This is the
264 default.
265
266 ata - the device type is ATA. This prevents smartd from issuing
267 SCSI commands to an ATA device.
268
269 scsi - the device type is SCSI. This prevents smartd from issu‐
270 ing ATA commands to a SCSI device.
271
272 nvme[,NSID] - the device type is NVM Express (NVMe). The op‐
273 tional parameter NSID specifies the namespace id (in hex) passed
274 to the driver. Use 0xffffffff for the broadcast namespace id.
275 The default for NSID is the namespace id addressed by the device
276 name.
277
278 sat[,auto][,N] - the device type is SCSI to ATA Translation
279 (SAT). This is for ATA disks that have a SCSI to ATA Transla‐
280 tion Layer (SATL) between the disk and the operating system.
281 SAT defines two ATA PASS THROUGH SCSI commands, one 12 bytes
282 long and the other 16 bytes long. The default is the 16 byte
283 variant which can be overridden with either '-d sat,12' or '-d
284 sat,16'.
285
286 If '-d sat,auto' is specified, device type SAT (for ATA/SATA
287 disks) is only used if the SCSI INQUIRY data reports a SATL
288 (VENDOR: "ATA "). Otherwise device type SCSI (for SCSI/SAS
289 disks) is used.
290
291 usbcypress - this device type is for ATA disks that are behind a
292 Cypress USB to PATA bridge. This will use the ATACB proprietary
293 scsi pass through command. The default SCSI operation code is
294 0x24, but although it can be overridden with '-d usbcy‐
295 press,0xN', where N is the scsi operation code, you're running
296 the risk of damage to the device or filesystems on it.
297
298 usbjmicron[,p][,x][,PORT] - this device type is for SATA disks
299 that are behind a JMicron USB to PATA/SATA bridge. The 48-bit
300 ATA commands (required e.g. for '-l xerror', see below) do not
301 work with all of these bridges and are therefore disabled by de‐
302 fault. These commands can be enabled by '-d usbjmicron,x'. If
303 two disks are connected to a bridge with two ports, an error
304 message is printed if no PORT is specified. The port can be
305 specified by '-d usbjmicron[,x],PORT' where PORT is 0 (master)
306 or 1 (slave). This is not necessary if the device uses a port
307 multiplier to connect multiple disks to one port. The disks ap‐
308 pear under separate /dev/ice names then. CAUTION: Specifying
309 ',x' for a device which does not support it results in I/O er‐
310 rors and may disconnect the drive. The same applies if the
311 specified PORT does not exist or is not connected to a disk.
312
313 The Prolific PL2507/3507 USB bridges with older firmware support
314 a pass-through command similar to JMicron and work with '-d usb‐
315 jmicron,0'. Newer Prolific firmware requires a modified command
316 which can be selected by '-d usbjmicron,p'. Note that this does
317 not yet support the SMART status command.
318
319 usbprolific - this device type is for SATA disks that are behind
320 a Prolific PL2571/2771/2773/2775 USB to SATA bridge.
321
322 usbsunplus - this device type is for SATA disks that are behind
323 a SunplusIT USB to SATA bridge.
324
325 sntasmedia - [NEW EXPERIMENTAL SMARTD FEATURE] this device type
326 is for NVMe disks that are behind an ASMedia USB to NVMe bridge.
327
328 sntjmicron[,NSID] - this device type is for NVMe disks that are
329 behind a JMicron USB to NVMe bridge. The optional parameter
330 NSID specifies the namespace id (in hex) passed to the driver.
331 The default namespace id is the broadcast namespace id
332 (0xffffffff).
333
334 sntrealtek - [NEW EXPERIMENTAL SMARTD FEATURE] this device type
335 is for NVMe disks that are behind a Realtek USB to NVMe bridge.
336
337 marvell - [Linux only] interact with SATA disks behind Marvell
338 chip-set controllers (using the Marvell rather than libata
339 driver).
340
341 megaraid,N - [Linux and FreeBSD only] the device consists of one
342 or more SCSI/SAS disks connected to a MegaRAID controller. The
343 non-negative integer N (in the range of 0 to 127 inclusive) de‐
344 notes which disk on the controller is monitored. This interface
345 will also work for Dell PERC controllers. In log files and
346 email messages this disk will be identified as megaraid_disk_XXX
347 with XXX in the range from 000 to 127 inclusive.
348
349 Please see the smartctl(8) man page for further details.
350
351 aacraid,H,L,ID - [Linux, Windows and Cygwin only] the device
352 consists of one or more SCSI/SAS or SATA disks connected to an
353 AacRaid controller. The non-negative integers H,L,ID (Host num‐
354 ber, Lun, ID) denote which disk on the controller is monitored.
355 In log files and email messages this disk will be identified as
356 aacraid_disk_HH_LL_ID. Please see the smartctl(8) man page for
357 further details.
358
359 3ware,N - [FreeBSD and Linux only] the device consists of one or
360 more ATA disks connected to a 3ware RAID controller. The non-
361 negative integer N (in the range from 0 to 127 inclusive) de‐
362 notes which disk on the controller is monitored. In log files
363 and email messages this disk will be identified as
364 3ware_disk_XXX with XXX in the range from 000 to 127 inclusive.
365
366 Note that while you may use any of the 3ware SCSI logical de‐
367 vices /dev/tw* to address any of the physical disks (3ware
368 ports), error and log messages will make the most sense if you
369 always list the 3ware SCSI logical device corresponding to the
370 particular physical disks. Please see the smartctl(8) man page
371 for further details.
372
373 areca,N - [FreeBSD, Linux, Windows and Cygwin only] the device
374 consists of one or more SATA disks connected to an Areca SATA
375 RAID controller. The positive integer N (in the range from 1 to
376 24 inclusive) denotes which disk on the controller is monitored.
377 In log files and email messages this disk will be identified as
378 areca_disk_XX with XX in the range from 01 to 24 inclusive.
379 Please see the smartctl(8) man page for further details.
380
381 areca,N/E - [FreeBSD, Linux, Windows and Cygwin only] the device
382 consists of one or more SATA or SAS disks connected to an Areca
383 SAS RAID controller. The integer N (range 1 to 128) denotes the
384 channel (slot) and E (range 1 to 8) denotes the enclosure. Im‐
385 portant: This requires Areca SAS controller firmware version
386 1.51 or later.
387
388 cciss,N - [FreeBSD and Linux only] the device consists of one or
389 more SCSI/SAS or SATA disks connected to a cciss RAID con‐
390 troller. The non-negative integer N (in the range from 0 to 15
391 inclusive) denotes which disk on the controller is monitored.
392 In log files and email messages this disk will be identified as
393 cciss_disk_XX with XX in the range from 00 to 15 inclusive.
394 Please see the smartctl(8) man page for further details.
395
396 hpt,L/M/N - [FreeBSD and Linux only] the device consists of one
397 or more ATA disks connected to a HighPoint RocketRAID con‐
398 troller. The integer L is the controller id, the integer M is
399 the channel number, and the integer N is the PMPort number if it
400 is available. The allowed values of L are from 1 to 4 inclu‐
401 sive, M are from 1 to 128 inclusive and N from 1 to 4 if PMPort
402 available. And also these values are limited by the model of
403 the HighPoint RocketRAID controller. In log files and email
404 messages this disk will be identified as hpt_X/X/X and X/X/X is
405 the same as L/M/N, note if no N indicated, N set to the default
406 value 1. Please see the smartctl(8) man page for further de‐
407 tails.
408
409 intelliprop,N[+TYPE] - the device consists of multiple ATA disks
410 connected to an Intelliprop controller. The integer N is the
411 port number from 0 to 3 of the ATA drive to be targeted. Please
412 see the smartctl(8) man page for further details.
413
414 jmb39x[-q],N[,sLBA][,force][+TYPE] - [NEW EXPERIMENTAL SMARTD
415 FEATURE] the device consists of multiple SATA disks connected to
416 a JMicron JMB39x RAID port multiplier. The suffix '-q' selects
417 a slightly different command variant used by some QNAP NAS de‐
418 vices. The integer N is the port number from 0 to 4. Please
419 see the smartctl(8) man page for further details.
420
421 jms56x,N[,sLBA][,force][+TYPE] - [NEW EXPERIMENTAL SMARTD FEA‐
422 TURE] the device consists of multiple SATA disks connected to a
423 JMicron JMS56x USB to SATA RAID bridge. See 'jmb39x...' above
424 for valid arguments.
425
426 ignore - the device specified by this configuration entry should
427 be ignored. This allows one to ignore specific devices which
428 are detected by a following DEVICESCAN configuration line. It
429 may also be used to temporary disable longer multi-line configu‐
430 ration entries. This Directive may be used in conjunction with
431 the other '-d' Directives.
432
433 removable - the device or its media is removable. This indi‐
434 cates to smartd that it should continue (instead of exiting,
435 which is the default behavior) if the device does not appear to
436 be present when smartd is started. This directive also sup‐
437 presses warning emails and repeated log messages if the device
438 is removed after startup. This Directive may be used in con‐
439 junction with the other '-d' Directives.
440 WARNING: Removing a device and connecting a different one to
441 same interface is not supported and may result in bogus warnings
442 until smartd is restarted.
443
444 -n POWERMODE[,N][,q]
445 [ATA only] This 'nocheck' Directive is used to prevent a disk
446 from being spun-up when it is periodically polled by smartd.
447
448 ATA disks have five different power states. In order of in‐
449 creasing power consumption they are: 'OFF', 'SLEEP', 'STANDBY',
450 'IDLE', and 'ACTIVE'. Typically in the OFF, SLEEP, and STANDBY
451 modes the disk's platters are not spinning. But usually, in re‐
452 sponse to SMART commands issued by smartd, the disk platters are
453 spun up. So if this option is not used, then a disk which is in
454 a low-power mode may be spun up and put into a higher-power mode
455 when it is periodically polled by smartd.
456
457 Note that if the disk is in SLEEP mode when smartd is started,
458 then it won't respond to smartd commands, and so the disk won't
459 be registered as a device for smartd to monitor. If a disk is
460 in any other low-power mode, then the commands issued by smartd
461 to register the disk will probably cause it to spin-up.
462
463 The '-n' (nocheck) Directive specifies if smartd's periodic
464 checks should still be carried out when the device is in a low-
465 power mode. It may be used to prevent a disk from being spun-up
466 by periodic smartd polling. The allowed values of POWERMODE
467 are:
468
469 never - smartd will poll (check) the device regardless of its
470 power mode. This may cause a disk which is spun-down to be
471 spun-up when smartd checks it. This is the default behavior if
472 the '-n' Directive is not given.
473
474 sleep - check the device unless it is in SLEEP mode.
475
476 standby - check the device unless it is in SLEEP or STANDBY
477 mode. In these modes most disks are not spinning, so if you
478 want to prevent a laptop disk from spinning up each time that
479 smartd polls, this is probably what you want.
480
481 idle - check the device unless it is in SLEEP, STANDBY or IDLE
482 mode. In the IDLE state, most disks are still spinning, so this
483 is probably not what you want.
484
485 Maximum number of skipped checks (in a row) can be specified by
486 appending positive number ',N' to POWERMODE (like '-n
487 standby,15'). After N checks are skipped in a row, powermode is
488 ignored and the check is performed anyway.
489
490 When a periodic test is skipped, smartd normally writes an in‐
491 formal log message. The message can be suppressed by appending
492 the option ',q' to POWERMODE (like '-n standby,q'). This pre‐
493 vents a laptop disk from spinning up due to this message.
494
495 Both ',N' and ',q' can be specified together.
496
497 -T TYPE
498 Specifies how tolerant smartd should be of SMART command fail‐
499 ures. The valid arguments to this Directive are:
500
501 normal - do not try to monitor the disk if a mandatory SMART
502 command fails, but continue if an optional SMART command fails.
503 This is the default.
504
505 permissive - try to monitor the disk even if it appears to lack
506 SMART capabilities. This may be required for some old disks
507 (prior to ATA-3 revision 4) that implemented SMART before the
508 SMART standards were incorporated into the ATA/ATAPI Specifica‐
509 tions. [Please see the smartctl -T command-line option.]
510
511 -o VALUE
512 [ATA only] Enables or disables SMART Automatic Offline Testing
513 when smartd starts up and has no further effect. The valid ar‐
514 guments to this Directive are on and off.
515
516 The delay between tests is vendor-specific, but is typically
517 four hours.
518
519 Note that SMART Automatic Offline Testing is not part of the ATA
520 Specification. Please see the smartctl -o command-line option
521 documentation for further information about this feature.
522
523 -S VALUE
524 Enables or disables Attribute Autosave when smartd starts up and
525 has no further effect. The valid arguments to this Directive
526 are on and off. Also affects SCSI devices. [Please see the
527 smartctl -S command-line option.]
528
529 -H [ATA] Check the health status of the disk with the SMART RETURN
530 STATUS command. If this command reports a failing health sta‐
531 tus, then disk failure is predicted in less than 24 hours, and a
532 message at loglevel 'LOG_CRIT' will be logged to syslog.
533 [Please see the smartctl -H command-line option.]
534
535 [NVMe] Checks the "Critical Warning" byte from the SMART/Health
536 Information log. If any warning bit is set, a message at
537 loglevel 'LOG_CRIT' will be logged to syslog.
538
539 -l TYPE
540 Reports increases in the number of errors in one of three SMART
541 logs. The valid arguments to this Directive are:
542
543 error - [ATA] report if the number of ATA errors reported in the
544 Summary SMART error log has increased since the last check.
545
546 error - [NVMe] report if the "Number of Error Information Log
547 Entries" from the SMART/Health Information log has increased
548 since the last check.
549
550 xerror - [ATA] report if the number of ATA errors reported in
551 the Extended Comprehensive SMART error log has increased since
552 the last check.
553
554 If both '-l error' and '-l xerror' are specified, smartd checks
555 the maximum of both values.
556
557 [Please see the smartctl -l xerror command-line option.]
558
559 xerror - [NVMe] same as '-l error'.
560
561 selftest - report if the number of failed tests reported in the
562 SMART Self-Test Log has increased since the last check, or if
563 the timestamp associated with the most recent failed test has
564 increased. Note that such errors will only be logged if you run
565 self-tests on the disk (and it fails a test!). Self-Tests can
566 be run automatically by smartd: please see the '-s' Directive
567 below. Self-Tests can also be run manually by using the '-t
568 short' and '-t long' options of smartctl and the results of the
569 testing can be observed using the smartctl '-l selftest' com‐
570 mand-line option. [Please see the smartctl -l and -t command-
571 line options.]
572
573 [ATA only] Failed self-tests outdated by a newer successful ex‐
574 tended self-test are ignored. The warning email counter is re‐
575 set if the number of failed self tests dropped to 0. This typi‐
576 cally happens when an extended self-test is run after all bad
577 sectors have been reallocated.
578
579 offlinests[,ns] - [ATA only] report if the Offline Data Collec‐
580 tion status has changed since the last check. The report will
581 be logged as LOG_CRIT if the new status indicates an error.
582 With some drives the status often changes, therefore '-l of‐
583 flinests' is not enabled by '-a' Directive. Appending ',ns' (no
584 standby) to this directive is not implemented on Linux.
585
586 selfteststs[,ns] - [ATA only] report if the Self-Test execution
587 status has changed since the last check. The report will be
588 logged as LOG_CRIT if the new status indicates an error. Ap‐
589 pending ',ns' (no standby) to this directive is not implemented
590 on Linux.
591
592 scterc,READTIME,WRITETIME - [ATA only] sets the SCT Error Recov‐
593 ery Control settings to the specified values (deciseconds) when
594 smartd starts up and has no further effect. Values of 0 disable
595 the feature, other values less than 65 are probably not sup‐
596 ported. For RAID configurations, this is typically set to 70,70
597 deciseconds. [Please see the smartctl -l scterc command-line
598 option.]
599
600 -e NAME[,VALUE]
601 Sets non-SMART device settings when smartd starts up and has no
602 further effect. [Please see the smartctl --set command-line op‐
603 tion.] Valid arguments are:
604
605 aam,[N|off] - [ATA only] Sets the Automatic Acoustic Management
606 (AAM) feature.
607
608 apm,[N|off] - [ATA only] Sets the Advanced Power Management
609 (APM) feature.
610
611 lookahead,[on|off] - [ATA only] Sets the read look-ahead fea‐
612 ture.
613
614 security-freeze - [ATA only] Sets ATA Security feature to frozen
615 mode.
616
617 standby,[N|off] - [ATA only] Sets the standby (spindown) timer
618 and places the drive in the IDLE mode.
619
620 wcache,[on|off] - [ATA only] Sets the volatile write cache fea‐
621 ture.
622
623 dsn,[on|off] - [ATA only] Sets the DSN feature.
624
625 -s REGEXP
626 Run Self-Tests or Offline Immediate Tests, at scheduled times.
627 A Self- or Offline Immediate Test will be run at the end of pe‐
628 riodic device polling, if all 12 characters of the string
629 T/MM/DD/d/HH match the extended regular expression REGEXP.
630 Here:
631
632 T is the type of the test. The values that smartd will try to
633 match (in turn) are: 'L' for a Long Self-Test, 'S' for a
634 Short Self-Test, 'C' for a Conveyance Self-Test (ATA only),
635 and 'O' for an Offline Immediate Test (ATA only). As soon
636 as a match is found, the test will be started and no addi‐
637 tional matches will be sought for that device and that
638 polling cycle.
639
640 To run scheduled Selective Self-Tests, use 'n' for next
641 span, 'r' to redo last span, or 'c' to continue with next
642 span or redo last span based on status of last test. The
643 LBA range is based on the first span from the last test.
644 See the smartctl -t select,[next|redo|cont] options for fur‐
645 ther info.
646
647 Some disks (e.g. WD) do not preserve the selective self test
648 log across power cycles. If state persistence ('-s' option)
649 is enabled, the last test span is preserved by smartd and
650 used if (and only if) the selective self test log is empty.
651
652 MM is the month of the year, expressed with two decimal digits.
653 The range is from 01 (January) to 12 (December) inclusive.
654 Do not use a single decimal digit or the match will always
655 fail!
656
657 DD is the day of the month, expressed with two decimal digits.
658 The range is from 01 to 31 inclusive. Do not use a single
659 decimal digit or the match will always fail!
660
661 d is the day of the week, expressed with one decimal digit.
662 The range is from 1 (Monday) to 7 (Sunday) inclusive.
663
664 HH is the hour of the day, written with two decimal digits, and
665 given in hours after midnight. The range is 00 (midnight to
666 just before 1 am) to 23 (11pm to just before midnight) in‐
667 clusive. Do not use a single decimal digit or the match
668 will always fail!
669
670 [NEW EXPERIMENTAL SMARTD FEATURE] If the regular expression con‐
671 tains substrings of the form :NNN or :NNN-LLL, where NNN and LLL
672 are three decimal digits, staggered tests are enabled. Then a
673 test will also be run if all 16 (or 20) characters of the string
674 T/MM/DD/d/HH:NNN (or T/MM/DD/d/HH:NNN-LLL) match the regular ex‐
675 pression. This check is done for up to seven :NNN or :NNN-LLL
676 found in the regular expression. The time used for the check is
677 adjusted to the past such that tests of the first drive are not
678 delayed, tests of the second drive are delayed by NNN hours,
679 tests of the third drive are delayed by 2*NNN hours, and so on.
680 If LLL is also specified, delays are limited to LLL hours by
681 calculating each individual delay as:
682 '((DRIVE_INDEX * NNN) mod (LLL + 1))'.
683
684 Some examples follow. In reading these, keep in mind that in
685 extended regular expressions a dot '.' matches any single char‐
686 acter, and a parenthetical expression such as '(A|B|C)' denotes
687 any one of the three possibilities A, B, or C.
688
689 To schedule a short Self-Test between 2–3 am every morning, use:
690 -s S/../.././02
691 To schedule a long Self-Test between 4–5 am every Sunday morn‐
692 ing, use:
693 -s L/../../7/04
694 To enable staggered tests with delays in three hour steps, use:
695 -s L/../../7/04:003
696 To enable staggered tests with delays 0, 3, 6, 9, 1, 4, 7, 10,
697 2, 5, 8, 0, ... hours, use:
698 -s L/../../7/04:003-010
699 To enable staggered tests with delays 0, 1, 2, ..., 9, 10, 0,
700 ... hours, use:
701 -s L/../../7/04:001-010
702 To schedule a long Self-Test between 10–11 pm on the first and
703 fifteenth day of each month, use:
704 -s L/../(01|15)/./22
705 To schedule an Offline Immediate test after every midnight, 6
706 am, noon, and 6 pm, plus a Short Self-Test daily at 1–2 am and a
707 Long Self-Test every Saturday at 3–4 am, use:
708 -s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)
709 To enable staggered Long Self-Tests with delays in three hour
710 steps, use:
711 -s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03:003)
712 If Long Self-Tests of a large disks take longer than the system
713 uptime, a full disk test can be performed by several Selective
714 Self-Tests. To setup a full test of a 1 TB disk within 20 days
715 (one 50 GB span each day), run this command once:
716 smartctl -t select,0-99999999 /dev/sda
717 To run the next test spans on Monday–Friday between 12–13 am,
718 run smartd with this directive:
719 -s n/../../[1-5]/12
720
721 Scheduled tests are run immediately following the regularly-
722 scheduled device polling, if the current local date, time, and
723 test type, match REGEXP. By default the regularly-scheduled de‐
724 vice polling occurs every thirty minutes after starting smartd.
725 Take caution if you use the '-i' option to make this polling in‐
726 terval more than sixty minutes: the poll times may fail to coin‐
727 cide with any of the testing times that you have specified with
728 REGEXP. In this case the test will be run following the next
729 device polling.
730
731 Before running an offline or self-test, smartd checks to be sure
732 that a self-test is not already running. If a self-test is al‐
733 ready running, then this running self test will not be inter‐
734 rupted to begin another test.
735
736 smartd will not attempt to run any type of test if another test
737 was already started or run in the same hour.
738
739 To avoid performance problems during system boot, smartd will
740 not attempt to run any scheduled tests following the very first
741 device polling (unless '-q onecheck' is specified).
742
743 Each time a test is run, smartd will log an entry to SYSLOG.
744 You can use these or the '-q showtests' command-line option to
745 verify that you constructed REGEXP correctly. The matching or‐
746 der (L before S before C before O) ensures that if multiple test
747 types are all scheduled for the same hour, the longer test type
748 has precedence. This is usually the desired behavior.
749
750 If the scheduled tests are used in conjunction with state per‐
751 sistence ('-s' option), smartd will also try to match the hours
752 since last shutdown (or 90 days at most). If any test would
753 have been started during downtime, the longest (see above) of
754 these tests is run after second device polling.
755
756 If the '-n' directive is used and any test would have been
757 started during disk standby time, the longest of these tests is
758 run when the disk is active again.
759
760 Unix users: please beware that the rules for extended regular
761 expressions [regex(7)] are not the same as the rules for file-
762 name pattern matching by the shell [glob(7)]. smartd will issue
763 harmless informational warning messages if it detects characters
764 in REGEXP that appear to indicate that you have made this mis‐
765 take.
766
767 -m ADD Send a warning email to the email address ADD if the '-H', '-l
768 error', '-l xerror', '-l selftest', '-f', '-C', '-U', or '-W'
769 Directives detect a failure or a new error, or if a SMART com‐
770 mand to the disk fails. This Directive only works in conjunc‐
771 tion with these other Directives (or with the equivalent default
772 '-a' Directive).
773
774 To prevent your email in-box from getting filled up with warning
775 messages, by default only a single warning and (depending on
776 '-s' option) daily reminder emails will be sent for each of the
777 enabled alert types. See the '-M' Directive below for details.
778
779 To send email to more than one user, please use the following
780 "comma separated" form for the address:
781 user1@add1,user2@add2,...,userN@addN (with no spaces).
782
783 To test that email is being sent correctly, use the '-M test'
784 Directive described below to send one test email message on
785 smartd startup.
786
787 By default, email is sent using the system mail(1) command. In
788 order that smartd find this command (normally /usr/bin/mail) the
789 executable must be in the path of the shell or environment from
790 which smartd was started. If you wish to specify an explicit
791 path to the mail executable (for example /usr/local/bin/mail) or
792 a custom script to run, please use the '-M exec' Directive be‐
793 low.
794
795 Note also that there is a special argument <nomailer> which can
796 be given to the '-m' Directive in conjunction with the '-M exec'
797 Directive. Please see below for an explanation of its effect.
798
799 If the mailer or the shell running it produces any STDERR/STDOUT
800 output, then a snippet of that output will be copied to SYSLOG.
801 The remainder of the output is discarded. If problems are en‐
802 countered in sending mail, this should help you to understand
803 and fix them. If you have mail problems, we recommend running
804 smartd in debug mode with the '-d' flag, using the '-M test' Di‐
805 rective described below.
806
807 If a word of the comma separated list has the form '@plugin', a
808 custom script /etc/smartmontools/smartd_warning.d/plugin is run
809 and the word is removed from the list before sending mail. The
810 string 'plugin' may be any valid name except 'ALL'. If '@ALL'
811 is specified, all scripts in /etc/smartmontools/smartd_warn‐
812 ing.d/* are run instead. This is handled by the script
813 /etc/smartmontools/smartd_warning.sh (see also '-M exec' below).
814 Plugin scripts without execute permission are silently ignored.
815 If any plugin script is missing or fails a with nonzero exit
816 status, the warning script exits immediately without sending
817 mail.
818
819 -M TYPE
820 These Directives modify the behavior of the smartd email warn‐
821 ings enabled with the '-m' email Directive described above.
822 These '-M' Directives only work in conjunction with the '-m' Di‐
823 rective and can not be used without it.
824
825 Multiple -M Directives may be given. If more than one of the
826 following three -M Directives are given (example: -M once -M
827 daily) then the final one (in the example, -M daily) is used.
828
829 The valid arguments to the -M Directive are (one of the follow‐
830 ing three):
831
832 once - send only one warning email for each type of disk problem
833 detected. This is the default unless state persistence ('-s'
834 option) is enabled.
835
836 daily - send additional warning reminder emails, once per day,
837 for each type of disk problem detected. This is the default if
838 state persistence ('-s' option) is enabled.
839
840 diminishing - send additional warning reminder emails, after a
841 one-day interval, then a two-day interval, then a four-day in‐
842 terval, and so on for each type of disk problem detected. Each
843 interval is twice as long as the previous interval.
844
845 If a disk problem is no longer detected, the internal email
846 counter is reset. If the problem reappears a new warning email
847 is sent immediately.
848
849 In addition, one may add zero or more of the following Direc‐
850 tives:
851
852 test - send a single test email immediately upon smartd startup.
853 This allows one to verify that email is delivered correctly.
854 Note that if this Directive is used, smartd will also send the
855 normal email warnings that were enabled with the '-m' Directive,
856 in addition to the single test email!
857
858 exec PATH - run the executable PATH instead of the default mail
859 command, when smartd needs to send email. PATH must point to an
860 executable binary file or script.
861
862 By setting PATH to point to a customized script, you can make
863 smartd perform useful tricks when a disk problem is detected
864 (beeping the console, shutting down the machine, broadcasting
865 warnings to all logged-in users, etc.) But please be careful.
866 smartd will block until the executable PATH returns, so if your
867 executable hangs, then smartd will also hang. Some sample
868 scripts are included in /usr/share/doc/smartmontools/example‐
869 scripts/.
870
871 The exit status of the executable is recorded by smartd in SYS‐
872 LOG. The executable is not expected to write to STDOUT or
873 STDERR. If it does, then this is interpreted as indicating that
874 something is going wrong with your executable, and a fragment of
875 this output is logged to SYSLOG to help you to understand the
876 problem. Normally, if you wish to leave some record behind, the
877 executable should send mail or write to a file or device.
878
879 Before running the executable, smartd sets a number of environ‐
880 ment variables. These environment variables may be used to con‐
881 trol the executable's behavior. The environment variables ex‐
882 ported by smartd are:
883
884 SMARTD_MAILER
885 is set to the argument of -M exec, if present or else to
886 'mail' (examples: /usr/local/bin/mail, mail).
887
888 SMARTD_DEVICE
889 is set to the device path (example: /dev/sda).
890
891 SMARTD_DEVICETYPE
892 is set to the device type specified by '-d' directive or
893 'auto' if none.
894
895 SMARTD_DEVICESTRING
896 is set to the device description. It starts with SMARTD_DE‐
897 VICE and may be followed by an optional controller identifi‐
898 cation (example: /dev/sda [SAT]). The string may contain a
899 space and is NOT quoted.
900
901 SMARTD_DEVICEINFO
902 is set to device identify information. It includes most of
903 the info printed by smartctl -i but uses a brief single line
904 format. This device info is also logged when smartd starts
905 up. The string contains space characters and is NOT quoted.
906
907 SMARTD_FAILTYPE
908 gives the reason for the warning or message email. The pos‐
909 sible values that it takes and their meanings are:
910 EmailTest: this is an email test message.
911 Health: the SMART health status indicates imminent failure.
912 Usage: a usage Attribute has failed.
913 SelfTest: the number of self-test failures has increased.
914 ErrorCount: the number of errors in the ATA error log has
915 increased.
916 CurrentPendingSector: one of more disk sectors could not be
917 read and are marked to be reallocated (replaced with spare
918 sectors).
919 OfflineUncorrectableSector: during off-line testing, or
920 self-testing, one or more disk sectors could not be read.
921 Temperature: Temperature reached critical limit (see -W di‐
922 rective).
923 FailedHealthCheck: the SMART health status command failed.
924 FailedReadSmartData: the command to read SMART Attribute
925 data failed.
926 FailedReadSmartErrorLog: the command to read the SMART error
927 log failed.
928 FailedReadSmartSelfTestLog: the command to read the SMART
929 self-test log failed.
930 FailedOpenDevice: the open() command to the device failed.
931
932 SMARTD_ADDRESS
933 is determined by the address argument ADD of the '-m' Direc‐
934 tive. If ADD is <nomailer>, then SMARTD_ADDRESS is not set.
935 Otherwise, it is set to the comma-separated-list of email
936 addresses given by the argument ADD, with the commas re‐
937 placed by spaces (example:admin@example.com root). If more
938 than one email address is given, then this string will con‐
939 tain space characters and is NOT quoted, so to use it in a
940 shell script you may want to enclose it in double quotes.
941
942 SMARTD_ADDRESS_ORIG
943 is set to the original value of SMARTD_ADDRESS with
944 '@plugin' strings still present. If there are no such
945 strings in the '-m' Directive, this variable is NOT set.
946
947 SMARTD_MESSAGE
948 is set to the one sentence summary warning email message
949 string from smartd. This message string contains space
950 characters and is NOT quoted. So to use $SMARTD_MESSAGE in
951 a shell script you should probably enclose it in double
952 quotes.
953
954 SMARTD_FULLMESSAGE
955 is set to the contents of the entire email warning message
956 string from smartd. This message string contains space and
957 return characters and is NOT quoted. So to use
958 $SMARTD_FULLMESSAGE in a shell script you should probably
959 enclose it in double quotes.
960
961 SMARTD_TFIRST
962 is a text string giving the time and date at which the first
963 problem of this type was reported. This text string con‐
964 tains space characters and no newlines, and is NOT quoted.
965 For example:
966 Sun Feb 9 14:58:19 2003 CST
967
968 SMARTD_TFIRSTEPOCH
969 is an integer, which is the unix epoch (number of seconds
970 since Jan 1, 1970) for SMARTD_TFIRST.
971
972 SMARTD_PREVCNT
973 is an integer specifying the number of previous messages
974 sent. It is set to '0' for the first message.
975
976 SMARTD_NEXTDAYS
977 is an integer specifying the number of days until the next
978 message will be sent. It it set to empty on '-M once' and
979 set to '1' on '-M daily'.
980
981 If the '-m ADD' Directive is given with a normal address argu‐
982 ment, then the executable pointed to by PATH will be run in a
983 shell with STDIN receiving the body of the email message, and
984 with the same command-line arguments:
985 -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS
986 that would normally be provided to 'mail'. Examples include:
987 -m user@home -M exec /usr/bin/mail
988 -m admin@work -M exec /usr/local/bin/mailto
989 -m root -M exec /Example_1/shell/script/below
990
991 If the '-m ADD' Directive is given with the special address ar‐
992 gument <nomailer> then the executable pointed to by PATH is run
993 in a shell with no STDIN and no command-line arguments, for ex‐
994 ample:
995 -m <nomailer> -M exec /Example_2/shell/script/below
996
997 If the executable produces any STDERR/STDOUT output, then smartd
998 assumes that something is going wrong, and a snippet of that
999 output will be copied to SYSLOG. The remainder of the output is
1000 then discarded.
1001
1002 Some EXAMPLES of scripts that can be used with the '-M exec' Di‐
1003 rective are given below. Some sample scripts are also included
1004 in /usr/share/doc/smartmontools/examplescripts/.
1005
1006 The executable is run by the script /etc/smartmon‐
1007 tools/smartd_warning.sh. This script formats subject and full
1008 message based on SMARTD_MESSAGE and other environment variables
1009 set by smartd. The environment variables SMARTD_SUBJECT and
1010 SMARTD_FULLMESSAGE are set by the script before running the exe‐
1011 cutable.
1012
1013 -f [ATA only] Check for 'failure' of any Usage Attributes. If
1014 these Attributes are less than or equal to the threshold, it
1015 does NOT indicate imminent disk failure. It "indicates an advi‐
1016 sory condition where the usage or age of the device has exceeded
1017 its intended design life period." [Please see the smartctl -A
1018 command-line option.]
1019
1020 -p [ATA only] Report anytime that a Prefail Attribute has changed
1021 its value since the last check. [Please see the smartctl -A
1022 command-line option.]
1023
1024 -u [ATA only] Report anytime that a Usage Attribute has changed its
1025 value since the last check. [Please see the smartctl -A com‐
1026 mand-line option.]
1027
1028 -t [ATA only] Equivalent to turning on the two previous flags '-p'
1029 and '-u'. Tracks changes in all device Attributes (both Pre‐
1030 failure and Usage). [Please see the smartctl -A command-line
1031 option.]
1032
1033 -i ID [ATA only] Ignore device Attribute number ID when checking for
1034 failure of Usage Attributes. ID must be a decimal integer in
1035 the range from 1 to 255. This Directive modifies the behavior
1036 of the '-f' Directive and has no effect without it.
1037
1038 This is useful, for example, if you have a very old disk and
1039 don't want to keep getting messages about the hours-on-lifetime
1040 Attribute (usually Attribute 9) failing. This Directive may ap‐
1041 pear multiple times for a single device, if you want to ignore
1042 multiple Attributes.
1043
1044 -I ID [ATA only] Ignore device Attribute ID when tracking changes in
1045 the Attribute values. ID must be a decimal integer in the range
1046 from 1 to 255. This Directive modifies the behavior of the
1047 '-p', '-u', and '-t' tracking Directives and has no effect with‐
1048 out one of them.
1049
1050 This is useful, for example, if one of the device Attributes is
1051 the disk temperature (usually Attribute 194 or 231). It's an‐
1052 noying to get reports each time the temperature changes. This
1053 Directive may appear multiple times for a single device, if you
1054 want to ignore multiple Attributes.
1055
1056 -r ID[!]
1057 [ATA only] When tracking, report the Raw value of Attribute ID
1058 along with its (normally reported) Normalized value. ID must be
1059 a decimal integer in the range from 1 to 255. This Directive
1060 modifies the behavior of the '-p', '-u', and '-t' tracking Di‐
1061 rectives and has no effect without one of them. This Directive
1062 may be given multiple times.
1063
1064 A common use of this Directive is to track the device Tempera‐
1065 ture (often ID=194 or 231).
1066
1067 If the optional flag '!' is appended, a change of the Normalized
1068 value is considered critical. The report will be logged as
1069 LOG_CRIT and a warning email will be sent if '-m' is specified.
1070
1071 -R ID[!]
1072 [ATA only] When tracking, report whenever the Raw value of At‐
1073 tribute ID changes. (Normally smartd only tracks/reports
1074 changes of the Normalized Attribute values.) ID must be a deci‐
1075 mal integer in the range from 1 to 255. This Directive modifies
1076 the behavior of the '-p', '-u', and '-t' tracking Directives and
1077 has no effect without one of them. This Directive may be given
1078 multiple times.
1079
1080 If this Directive is given, it automatically implies the '-r'
1081 Directive for the same Attribute, so that the Raw value of the
1082 Attribute is reported.
1083
1084 A common use of this Directive is to track the device Tempera‐
1085 ture (often ID=194 or 231). It is also useful for understanding
1086 how different types of system behavior affects the values of
1087 certain Attributes.
1088
1089 If the optional flag '!' is appended, a change of the Raw value
1090 is considered critical. The report will be logged as LOG_CRIT
1091 and a warning email will be sent if '-m' is specified. An exam‐
1092 ple is '-R 5!' to warn when new sectors are reallocated.
1093
1094 -C ID[+]
1095 [ATA only] Report if the current number of pending sectors is
1096 non-zero. Here ID is the id number of the Attribute whose raw
1097 value is the Current Pending Sector count. The allowed range of
1098 ID is 0 to 255 inclusive. To turn off this reporting, use
1099 ID = 0. If the -C ID option is not given, then it defaults to
1100 -C 197 (since Attribute 197 is generally used to monitor pending
1101 sectors). If the name of this Attribute is changed by a '-v
1102 197,FORMAT,NAME' directive, the default is changed to -C 0.
1103
1104 If '+' is specified, a report is only printed if the number of
1105 sectors has increased between two check cycles. Some disks do
1106 not reset this attribute when a bad sector is reallocated. See
1107 also '-v 197,increasing' below.
1108
1109 The warning email counter is reset if the number of pending sec‐
1110 tors dropped to 0. This typically happens when all pending sec‐
1111 tors have been reallocated or could be read again.
1112
1113 A pending sector is a disk sector (containing 512 bytes of your
1114 data) which the device would like to mark as "bad" and reallo‐
1115 cate. Typically this is because your computer tried to read
1116 that sector, and the read failed because the data on it has been
1117 corrupted and has inconsistent Error Checking and Correction
1118 (ECC) codes. This is important to know, because it means that
1119 there is some unreadable data on the disk. The problem of fig‐
1120 uring out what file this data belongs to is operating system and
1121 file system specific. You can typically force the sector to re‐
1122 allocate by writing to it (translation: make the device substi‐
1123 tute a spare good sector for the bad one) but at the price of
1124 losing the 512 bytes of data stored there.
1125
1126 -U ID[+]
1127 [ATA only] Report if the number of offline uncorrectable sectors
1128 is non-zero. Here ID is the id number of the Attribute whose
1129 raw value is the Offline Uncorrectable Sector count. The al‐
1130 lowed range of ID is 0 to 255 inclusive. To turn off this re‐
1131 porting, use ID = 0. If the -U ID option is not given, then it
1132 defaults to -U 198 (since Attribute 198 is generally used to
1133 monitor offline uncorrectable sectors). If the name of this At‐
1134 tribute is changed by a '-v 198,FORMAT,NAME' (except '-v
1135 198,FORMAT,Offline_Scan_UNC_SectCt'), directive, the default is
1136 changed to -U 0.
1137
1138 If '+' is specified, a report is only printed if the number of
1139 sectors has increased since the last check cycle. Some disks do
1140 not reset this attribute when a bad sector is reallocated. See
1141 also '-v 198,increasing' below.
1142
1143 The warning email counter is reset if the number of offline un‐
1144 correctable sectors dropped to 0. This typically happens when
1145 all offline uncorrectable sectors have been reallocated or could
1146 be read again.
1147
1148 An offline uncorrectable sector is a disk sector which was not
1149 readable during an off-line scan or a self-test. This is impor‐
1150 tant to know, because if you have data stored in this disk sec‐
1151 tor, and you need to read it, the read will fail. Please see
1152 the previous '-C' option for more details.
1153
1154 -W DIFF[,INFO[,CRIT]]
1155 Report if the current temperature had changed by at least DIFF
1156 degrees since last report, or if new min or max temperature is
1157 detected. Report or Warn if the temperature is greater or equal
1158 than one of INFO or CRIT degrees Celsius. If the limit CRIT is
1159 reached, a message with loglevel 'LOG_CRIT' will be logged to
1160 syslog and a warning email will be send if '-m' is specified.
1161 If only the limit INFO is reached, a message with loglevel
1162 'LOG_INFO' will be logged.
1163
1164 The warning email counter is reset if the temperature dropped
1165 below INFO or CRIT-5 if INFO is not specified.
1166
1167 If this directive is used in conjunction with state persistence
1168 ('-s' option), the min and max temperature values are preserved
1169 across boot cycles. The minimum temperature value is not up‐
1170 dated during the first 30 minutes after startup.
1171
1172 To disable any of the 3 reports, set the corresponding limit to
1173 0. Trailing zero arguments may be omitted. By default, all
1174 temperature reports are disabled ('-W 0').
1175
1176 To track temperature changes of at least 2 degrees, use:
1177 -W 2
1178 To log informal messages on temperatures of at least 40 degrees,
1179 use:
1180 -W 0,40
1181 For warning messages/mails on temperatures of at least 45 de‐
1182 grees, use:
1183 -W 0,0,45
1184 To combine all of the above reports, use:
1185 -W 2,40,45
1186
1187 For ATA devices, smartd interprets Attribute 194 or 190 as Tem‐
1188 perature Celsius by default. This can be changed to Attribute 9
1189 or 220 by the drive database or by the '-v 9,temp' or '-v
1190 220,temp' directive.
1191
1192 For NVMe devices, smartd checks the maximum of the Composite
1193 Temperature value and all Temperature Sensor values reported by
1194 SMART/Health Information log.
1195
1196 -F TYPE
1197 [ATA only] Modifies the behavior of smartd to compensate for
1198 some known and understood device firmware bug. This directive
1199 may be used multiple times. The valid arguments are:
1200
1201 none - Assume that the device firmware obeys the ATA specifica‐
1202 tions. This is the default, unless the device has presets for
1203 '-F' in the drive database. Using this directive will override
1204 any preset values.
1205
1206 nologdir - Suppresses read attempts of SMART or GP Log Direc‐
1207 tory. Support for all standard logs is assumed without an ac‐
1208 tual check. Some Intel SSDs may freeze if log address 0 is
1209 read.
1210
1211 samsung - In some Samsung disks (example: model SV4012H Firmware
1212 Version: RM100-08) some of the two- and four-byte quantities in
1213 the SMART data structures are byte-swapped (relative to the ATA
1214 specification). Enabling this option tells smartd to evaluate
1215 these quantities in byte-reversed order. Some signs that your
1216 disk needs this option are (1) no self-test log printed, even
1217 though you have run self-tests; (2) very large numbers of ATA
1218 errors reported in the ATA error log; (3) strange and impossible
1219 values for the ATA error log timestamps.
1220
1221 samsung2 - In some Samsung disks the number of ATA errors re‐
1222 ported is byte swapped. Enabling this option tells smartd to
1223 evaluate this quantity in byte-reversed order.
1224
1225 samsung3 - Some Samsung disks (at least SP2514N with Firmware
1226 VF100-37) report a self-test still in progress with 0% remaining
1227 when the test was already completed. If this directive is spec‐
1228 ified, smartd will not skip the next scheduled self-test (see
1229 Directive '-s' above) in this case.
1230
1231 xerrorlba - This only affects smartctl.
1232
1233 [Please see the smartctl -F command-line option.]
1234
1235 -v ID,FORMAT[:BYTEORDER][,NAME]
1236 [ATA only] Sets a vendor-specific raw value print FORMAT, an op‐
1237 tional BYTEORDER and an optional NAME for Attribute ID. This
1238 directive may be used multiple times. Please see smartctl -v
1239 command-line option for further details.
1240
1241 The following arguments affect smartd warning output:
1242
1243 197,increasing - Raw Attribute number 197 (Current Pending Sec‐
1244 tor Count) is not reset if uncorrectable sectors are reallo‐
1245 cated. This sets '-C 197+' if no other '-C' directive is speci‐
1246 fied.
1247
1248 198,increasing - Raw Attribute number 198 (Offline Uncorrectable
1249 Sector Count) is not reset if uncorrectable sectors are reallo‐
1250 cated. This sets '-U 198+' if no other '-U' directive is speci‐
1251 fied.
1252
1253 -P TYPE
1254 [ATA only] Specifies whether smartd should use any preset op‐
1255 tions that are available for this drive. The valid arguments to
1256 this Directive are:
1257
1258 use - use any presets that are available for this drive. This
1259 is the default.
1260
1261 ignore - do not use any presets for this drive.
1262
1263 show - show the presets listed for this drive in the database.
1264
1265 showall - show the presets that are available for all drives and
1266 then exit.
1267
1268 [Please see the smartctl -P command-line option.]
1269
1270 -a Equivalent to turning on all of the following Directives: '-H'
1271 to check the SMART health status, '-f' to report failures of Us‐
1272 age (rather than Prefail) Attributes, '-t' to track changes in
1273 both Prefailure and Usage Attributes, '-l error' to report in‐
1274 creases in the number of ATA errors, '-l selftest' to report in‐
1275 creases in the number of Self-Test Log errors, '-l selfteststs'
1276 to report changes of Self-Test execution status, '-C 197' to re‐
1277 port nonzero values of the current pending sector count, and '-U
1278 198' to report nonzero values of the offline pending sector
1279 count.
1280
1281 Note that -a is the default for ATA devices. If none of these
1282 other Directives is given, then -a is assumed.
1283
1284 -c OPTION=VALUE
1285 Allows one to override smartd command line options for specific
1286 devices. Only the following OPTION is currently supported:
1287
1288 -c i=N, -c interval=N
1289 [NEW EXPERIMENTAL SMARTD FEATURE] Sets the interval between disk
1290 checks to N seconds, where N is a decimal integer. The minimum
1291 allowed value is ten. The default is the value from the '-i N,
1292 --interval=N' command line option or its default of 1800 sec‐
1293 onds.
1294
1295 # Comment: ignore the remainder of the line.
1296
1297 \ Continuation character: if this is the last non-white or non-
1298 comment character on a line, then the following line is a con‐
1299 tinuation of the current one.
1300
1301 If you are not sure which Directives to use, I suggest experimenting
1302 for a few minutes with smartctl to see what SMART functionality your
1303 disk(s) support(s). If you do not like voluminous syslog messages, a
1304 good choice of smartd configuration file Directives might be:
1305 -H -l selftest -l error -f.
1306 If you want more frequent information, use: -a.
1307
1308
1309 EXAMPLES OF SHELL SCRIPTS FOR '-M exec'
1310 These are two examples of shell scripts that can be used with
1311 the '-M exec PATH' Directive described previously. The paths to
1312 these scripts and similar executables is the PATH argument to
1313 the '-M exec PATH' Directive.
1314
1315 Example 1: This script is for use with '-m ADDRESS -M exec
1316 PATH'. It appends the output of smartctl -a to the output of
1317 the smartd email warning message and sends it to ADDRESS.
1318
1319 #! /bin/sh
1320
1321 # Save the email message (STDIN) to a file:
1322 cat > /root/msg
1323
1324 # Append the output of smartctl -a to the message:
1325 /usr/sbin/smartctl -a -d $SMART_DEVICETYPE \
1326 $SMARTD_DEVICE >> /root/msg
1327
1328 # Now email the message to the user at address ADD:
1329 /usr/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS \
1330 < /root/msg
1331
1332 Example 2: This script is for use with '-m <nomailer> -M exec
1333 PATH'. It warns all users about a disk problem, waits 30 sec‐
1334 onds, and then powers down the machine.
1335
1336 #! /bin/sh
1337
1338 # Warn all users of a problem
1339 wall <<EOF
1340 Problem detected with disk: $SMARTD_DEVICESTRING
1341 Warning message from smartd is: $SMARTD_MESSAGE
1342 Shutting down machine in 30 seconds...
1343 EOF
1344
1345 # Wait half a minute
1346 sleep 30
1347
1348 # Power down the machine
1349 /sbin/shutdown -hf now
1350
1351 Some example scripts are distributed with the smartmontools
1352 package, in /usr/share/doc/smartmontools/examplescripts/.
1353
1354 Please note that these scripts typically run as root, so any
1355 files that they read/write should not be writable by ordinary
1356 users or reside in directories like /tmp that are writable by
1357 ordinary users and may expose your system to symlink attacks.
1358
1359 As previously described, if the scripts write to STDOUT or
1360 STDERR, this is interpreted as indicating that there was an in‐
1361 ternal error within the script, and a snippet of STDOUT/STDERR
1362 is logged to SYSLOG. The remainder is flushed.
1363
1364
1366 /etc/smartmontools/smartd.conf
1367 full path of this file.
1368
1369
1371 smartd(8), smartctl(8), mail(1), regex(7).
1372
1373
1375 smartmontools-7.3 2022-02-28 r5338
1376 $Id: smartd.conf.5.in 5333 2022-02-26 00:15:22Z dpgilbert $
1377
1378
1379
1380smartmontools-7.3 2022-02-28 SMARTD.CONF(5)