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