root/trunk/smartmontools/smartd.conf.5.in @ 3542

Revision 3542, 61.0 KB (checked in by samm2, 2 years ago)

os_freebsd.cpp: copy&paste changes from Linux code, updating manual as well

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