1SMARTD.CONF(5)              SMART Monitoring Tools              SMARTD.CONF(5)
2
3
4

NAME

6       smartd.conf - SMART Disk Monitoring Daemon Configuration File
7
8

DESCRIPTION

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       # 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

DEVICESCAN

152       If a non-comment entry in the configuration file is the text string DE‐
153       VICESCAN in capital letters, then  smartd  will  ignore  any  remaining
154       lines  in  the  configuration  file, and will scan for devices.  If DE‐
155       VICESCAN is not followed by any Directives, then '-a' will apply to all
156       devices.
157
158       DEVICESCAN  may optionally be followed by Directives that will apply to
159       all devices that are found in the scan.  For example
160
161         DEVICESCAN -m root@example.com
162
163       will scan for all devices, and then monitor them.   It  will  send  one
164       email warning per device for any problems that are found.
165
166         DEVICESCAN -H -m root@example.com
167
168       will  do the same, but only monitors the SMART health status of the de‐
169       vices, rather than the default '-a'.
170
171       Multiple '-d TYPE' options may be specified with DEVICESCAN to  combine
172       the scan results of more than one TYPE.
173
174       Configuration  entries  for specific devices may precede the DEVICESCAN
175       entry.  For example
176
177         DEFAULT -m root@example.com
178         /dev/sda -s S/../.././02
179         /dev/sdc -d ignore
180         DEVICESCAN -s L/../.././02
181
182       will scan for all devices except /dev/sda and /dev/sdc,  monitor  them,
183       and run a long test between 2–3 am every morning.  Device /dev/sda will
184       also be monitored, but only a short test will be run.  Device  /dev/sdc
185       will  be  ignored.   Warning  emails will be sent for all monitored de‐
186       vices.
187
188       A device is ignored by DEVICESCAN if a configuration line with the same
189       device name exists.
190       [NEW  EXPERIMENTAL  SMARTD  FEATURE] Symbolic links are resolved before
191       this check is done.
192
193       A device name is also ignored if another device with same identify  in‐
194       formation (vendor, model, firmware version, serial number, WWN) already
195       exists.
196
197

DEFAULT SETTINGS

199       If an entry in the configuration file starts with DEFAULT instead of  a
200       device  name, then all directives in this entry are set as defaults for
201       the next device entries.
202
203       This configuration:
204
205         DEFAULT -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
206         /dev/sda
207         /dev/sdb
208         /dev/sdc
209         DEFAULT -H -m admin@example.com
210         /dev/sdd
211         /dev/sde -d removable
212
213       has the same effect as:
214
215         /dev/sda -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
216         /dev/sdb -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
217         /dev/sdc -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
218         /dev/sdd -H -m admin@example.com
219         /dev/sde -d removable -H -m admin@example.com
220
221

CONFIGURATION FILE DIRECTIVES

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

FILES

1342       /etc/smartmontools/smartd.conf
1343              full path of this file.
1344
1345

SEE ALSO

1347       smartd(8), smartctl(8), mail(1), regex(7).
1348
1349

PACKAGE VERSION

1351       smartmontools-7.2 2020-12-30 r5155
1352       $Id: smartd.conf.5.in 5118 2020-11-23 18:25:16Z chrfranke $
1353
1354
1355
1356smartmontools-7.2                 2020-12-30                    SMARTD.CONF(5)
Impressum