.ig
-Copyright (C) 2002-8 Bruce Allen <smartmontools-support@lists.sourceforge.net>
+Copyright (C) 2002-10 Bruce Allen <smartmontools-support@lists.sourceforge.net>
+Copyright (C) 2004-14 Christian Franke <smartmontools-support@lists.sourceforge.net>
-$Id: smartd.conf.5.in 2977 2009-10-30 22:29:05Z chrfranke $
+$Id: smartd.conf.5.in 3965 2014-07-20 14:46:41Z chrfranke $
-This program is free software; you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the Free
-Software Foundation; either version 2, or (at your option) any later
-version.
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option)
+any later version.
-You should have received a copy of the GNU General Public License (for
-example COPYING); if not, write to the Free Software Foundation, Inc., 675
-Mass Ave, Cambridge, MA 02139, USA.
+You should have received a copy of the GNU General Public License
+(for example COPYING); If not, see <http://www.gnu.org/licenses/>.
This code was originally developed as a Senior Thesis by Michael Cornwell
at the Concurrent Systems Laboratory (now part of the Storage Systems
Research Center), Jack Baskin School of Engineering, University of
California, Santa Cruz. http://ssrc.soe.ucsc.edu/
+
..
-.TH SMARTD.CONF 5 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE
+.TH SMARTD.CONF 5 CURRENT_SVN_DATE CURRENT_SVN_VERSION CURRENT_SVN_DATE
.SH NAME
\fBsmartd.conf\fP \- SMART Disk Monitoring Daemon Configuration File\fP
-.SH FULL PATH
-.B /usr/local/etc/smartd.conf
-
.SH PACKAGE VERSION
-CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME
+CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
.SH DESCRIPTION
+.\" %IF NOT OS ALL
+.\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools.
+.\"! It does not contain info specific to other platforms.]
+.\"! .PP
+.\" %ENDIF NOT OS ALL
\fB/usr/local/etc/smartd.conf\fP is the configuration file for the \fBsmartd\fP
-daemon, which monitors the Self-Monitoring, Analysis and Reporting
-Technology (SMART) system built into many ATA-3 and later ATA, IDE and
-SCSI-3 hard drives.
+daemon.
If the configuration file \fB/usr/local/etc/smartd.conf\fP is present,
\fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the
\fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is
running.
-.\" DO NOT MODIFY THIS OR THE FOLLOWING TWO LINES. WHAT FOLLOWS
-.\" IS AUTOMATICALLY INCLUDED FROM THE FILE smartd.8.in
-.\" STARTINCLUDE
-
-.SH CONFIGURATION FILE /usr/local/etc/smartd.conf
-In the absence of a configuration file, under Linux
-\fBsmartd\fP
-will try to open the 20 ATA devices
-.B /dev/hd[a-t]
-and the 26 SCSI devices
-.B /dev/sd[a-z].
-Under FreeBSD,
-\fBsmartd\fP
-will try to open all existing ATA devices (with entries in /dev)
-.B /dev/ad[0-9]+
-and all existing SCSI devices (using CAM subsystem).
-Under NetBSD/OpenBSD,
-\fBsmartd\fP
-will try to open all existing ATA devices (with entries in /dev)
-.B /dev/wd[0-9]+c
-and all existing SCSI devices
-.B /dev/sd[0-9]+c.
-Under Solaris \fBsmartd\fP will try to open all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk
-devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.
-Under Windows \fBsmartd\fP will try to open all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")
-for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP
-(bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,
-and \fB"/dev/scsi[0-9][0-7]"\fP (ASPI adapter 0-9, ID 0-7) for SCSI
-devices on all versions of Windows.
-Under Darwin, \fBsmartd\fP will open any ATA block storage device.
+In the absence of a configuration file
+\fBsmartd\fP will try to open all available devices
+(see \fBsmartd\fP(8) man page).
+A configuration file with a single line \fB\'DEVICESCAN \-a'\fP
+would have the same effect.
This can be annoying if you have an ATA or SCSI device that hangs or
misbehaves when receiving SMART commands. Even if this causes no
-problems, you may be annoyed by the string of error log messages about
-block-major devices that can\'t be found, and SCSI devices that can\'t
-be opened.
+problems, you may be annoyed by the string of error log messages about devices
+that can\'t be opened.
One can avoid this problem, and gain more control over the types of
events monitored by
line. An example file is included with the
.B smartmontools
distribution. You will find this sample configuration file in
-\fB/usr/local/share/doc/smartmontools-5.1/\fP. For security, the configuration file
+\fB/usr/local/share/doc/smartmontools/\fP. For security, the configuration file
should not be writable by anyone but root. The syntax of the file is as
follows:
.IP \(bu 4
Note: a line whose first character is a hash sign \'#\' is treated as
a white-space blank line, \fBnot\fP as a non-existent line, and will
\fBend\fP a continuation line.
-.PP 0
-.fi
+.PP
+
Here is an example configuration file. It\'s for illustrative purposes
only; please don\'t copy it onto your system without reading to the end
of the
.B # device, four SATA disks connected to an Areca
.B # RAID controller, and one SATA disk.
.B #
-.nf
.B # First ATA disk on two different interfaces. On
.B # the second disk, start a long self-test every
.B # Sunday between 3 and 4 am.
.B \ \ /dev/hda -a -m admin@example.com,root@localhost
.B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03
.B #
-.nf
.B # SCSI disks. Send a TEST warning email to admin on
.B # startup.
.B #
.B \ \ /dev/sda
.B \ \ /dev/sdb -m admin@example.com -M test
.B #
-.nf
.B # Strange device. It\'s SCSI. Start a scheduled
.B # long self test between 5 and 6 am Monday/Thursday
.B \ \ /dev/weird -d scsi -s L/../../(1|4)/05
.B #
-.nf
.B # An ATA disk may appear as a SCSI device to the
.B # OS. If a SCSI to ATA Translation (SAT) layer
.B # is between the OS and the device then this can be
.B # environments.
.B \ \ /dev/sda -a -d sat
.B #
-.nf
+.\" %IF OS Linux
.B # Three disks connected to a MegaRAID controller
.B # Start short self-tests daily between 1-2, 2-3, and
.B # 3-4 am.
.B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01
.B \ \ /dev/sda -d megaraid,1 -a -s S/../.././02
.B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03
-.B
+.B \ \ /dev/bus/0 -d megaraid,2 -a -s S/../.././03
.B #
-.nf
+.B # Three disks connected to an AacRaid controller
+.B # Start short self-tests daily between 1-2, 2-3, and
+.B # 3-4 am.
+.B \ \ /dev/sda -d aacraid,0,0,66 -a -s S/../.././01
+.B \ \ /dev/sda -d aacraid,0,0,67 -a -s S/../.././02
+.B \ \ /dev/sda -d aacraid,0,0,68 -a -s S/../.././03
+.B #
+.\" %ENDIF OS Linux
.B # Four ATA disks on a 3ware 6/7/8000 controller.
.B # Start short self-tests daily between midnight and 1am,
.B # 1-2, 2-3, and 3-4 am. Starting with the Linux 2.6
.B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02
.B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03
.B #
-.nf
.B # Two ATA disks on a 3ware 9000 controller.
-.B # Start long self-tests Sundays between midnight and
+.B # Start long self-tests Sundays between midnight and
.B # 1am and 2-3 am
.B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00
.B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02
.B #
-.nf
+.B # Two SATA (not SAS) disks on a 3ware 9750 controller.
+.B # Start long self-tests Sundays between midnight and
+.B # 1am and 2-3 am
+.\" %IF OS Linux
+.B \ \ /dev/twl0 -d 3ware,0 -a -s L/../../7/00
+.B \ \ /dev/twl0 -d 3ware,1 -a -s L/../../7/02
+.\" %ENDIF OS Linux
+.\" %IF OS FreeBSD
+.B \ \ /dev/tws0 -d 3ware,0 -a -s L/../../7/00
+.B \ \ /dev/tws0 -d 3ware,1 -a -s L/../../7/02
+.\" %ENDIF OS FreeBSD
+.B #
.B # Three SATA disks on a HighPoint RocketRAID controller.
.B # Start short self-tests daily between 1-2, 2-3, and
.B # 3-4 am.
+.\" %IF OS Linux
.B # under Linux
.B \ \ /dev/sde -d hpt,1/1 -a -s S/../.././01
.B \ \ /dev/sde -d hpt,1/2 -a -s S/../.././02
.B \ \ /dev/sde -d hpt,1/3 -a -s S/../.././03
-.B # or under FreeBSD
-.B # /dev/hptrr -d hpt,1/1 -a -s S/../.././01
-.B # /dev/hptrr -d hpt,1/2 -a -s S/../.././02
-.B # /dev/hptrr -d hpt,1/3 -a -s S/../.././03
+.\" %ENDIF OS Linux
+.\" %IF OS FreeBSD
+.B # under FreeBSD
+.B /dev/hptrr -d hpt,1/1 -a -s S/../.././01
+.B /dev/hptrr -d hpt,1/2 -a -s S/../.././02
+.B /dev/hptrr -d hpt,1/3 -a -s S/../.././03
+.\" %ENDIF OS FreeBSD
.B #
-.nf
.B # Two SATA disks connected to a HighPoint RocketRAID
.B # via a pmport device. Start long self-tests Sundays
.B # between midnight and 1am and 2-3 am.
+.\" %IF OS Linux
.B # under Linux
.B \ \ /dev/sde -d hpt,1/4/1 -a -s L/../../7/00
.B \ \ /dev/sde -d hpt,1/4/2 -a -s L/../../7/02
-.B # or under FreeBSD
-.B # /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00
-.B # /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02
+.\" %ENDIF OS Linux
+.\" %IF OS FreeBSD
+.B # under FreeBSD
+.B \ \ /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00
+.B \ \ /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02
.B #
-.nf
+.\" %ENDIF OS FreeBSD
.B # Three SATA disks connected to an Areca
.B # RAID controller. Start long self-tests Sundays
.B # between midnight and 3 am.
+.\" %IF OS Linux
.B \ \ /dev/sg2 -d areca,1 -a -s L/../../7/00
.B \ \ /dev/sg2 -d areca,2 -a -s L/../../7/01
.B \ \ /dev/sg2 -d areca,3 -a -s L/../../7/02
+.\" %ENDIF OS Linux
+.\" %IF OS FreeBSD
+.B \ \ /dev/arcmsr0 -d areca,1 -a -s L/../../7/00
+.B \ \ /dev/arcmsr0 -d areca,2 -a -s L/../../7/01
+.B \ \ /dev/arcmsr0 -d areca,3 -a -s L/../../7/02
+.\" %ENDIF OS FreeBSD
.B #
-.nf
.B # The following line enables monitoring of the
.B # ATA Error Log and the Self-Test Error Log.
.B # It also tracks changes in both Prefailure
.B ################################################
.fi
-.PP
.SH CONFIGURATION FILE DIRECTIVES
-.PP
-
-If the first non-comment entry in the configuration file is the text
-string
+If a non-comment entry in the configuration file is the text string
.B DEVICESCAN
in capital letters, then
\fBsmartd\fP
devices that are found in the scan. Please see below for additional
details.
-.sp 2
+If an entry in the configuration file starts with
+.B DEFAULT
+instead of a device name, then all directives in this entry are set
+as defaults for the next device entries.
+.PP
+This configuration:
+.PP
+.nf
+\ \ DEFAULT -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
+\ \ /dev/sda
+\ \ /dev/sdb
+\ \ /dev/sdc
+\ \ DEFAULT -H -m admin@example.com
+\ \ /dev/sdd
+\ \ /dev/sde -d removable
+.fi
+.PP
+has the same effect as:
+.PP
+.nf
+\ \ /dev/sda -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
+\ \ /dev/sdb -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
+\ \ /dev/sdc -a -R5! -W 2,40,45 -I 194 -s L/../../7/00 -m admin@example.com
+\ \ /dev/sdd -H -m admin@example.com
+\ \ /dev/sde -d removable -H -m admin@example.com
+.fi
+
+
The following are the Directives that may appear following the device
name or
.B DEVICESCAN
+or
+.B DEFAULT
on any line of the
.B /usr/local/etc/smartd.conf
configuration file. Note that
status fails, or if new errors appear in the self-test log.
.B If a 3ware controller is used
-then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?
-or /dev/twa?) must be listed, along with the \'\-d 3ware,N\' Directive
-(see below). The individual ATA disks hosted by the 3ware controller
-appear to \fBsmartd\fP as normal ATA devices. Hence all the ATA
-directives can be used for these disks (but see note below).
+then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?,
+/dev/twa?, /dev/twl? or /dev/tws?) must be listed, along with the \'\-d 3ware,N\'
+Directive (see below). The individual ATA disks hosted by the 3ware
+controller appear to \fBsmartd\fP as normal ATA devices. Hence all
+the ATA directives can be used for these disks (but see note below).
+.\" %IF OS Linux FreeBSD
.B If an Areca controller is used
-then the corresponding SCSI generic device (/dev/sg?) must be listed,
-along with the \'\-d areca,N\' Directive (see below). The individual
-SATA disks hosted by the Areca controller appear to \fBsmartd\fP as
-normal ATA devices. Hence all the ATA directives can be used for
+then the corresponding device (SCSI /dev/sg? on Linux or /dev/arcmsr0 on
+FreeBSD) must be listed, along with the \'\-d areca,N\' Directive (see below).
+The individual SATA disks hosted by the Areca controller appear to \fBsmartd\fP
+as normal ATA devices. Hence all the ATA directives can be used for
these disks. Areca firmware version 1.46 or later which supports
smartmontools must be used; Please see the \fBsmartctl\fP(8) man page
for further details.
-
+.\" %ENDIF OS Linux FreeBSD
.TP
.B \-d TYPE
-Specifies the type of the device. This Directive may be used multiple
-times for one device, but the arguments \fIata\fP, \fIscsi\fP,
-\fIsat\fP, \fImarvell\fP, \fIcciss,N\fP, \fIareca,N\fP, \fImegaraid,N\fP
-and \fI3ware,N\fP are mutually-exclusive. If more than one is given then
-\fBsmartd\fP will use the last one which appears.
-
-If none of these three arguments is given, then \fBsmartd\fP will
-first attempt to guess the device type by looking at whether the sixth
-character in the device name is an \'s\' or an \'h\'. This will work for
-device names like /dev/hda or /dev/sdb, and corresponds to choosing
-\fIata\fP or \fIscsi\fP respectively. If
-\fBsmartd\fP
-can\'t guess from this sixth character, then it will simply try to
-access the device using first ATA and then SCSI ioctl()s.
+Specifies the type of the device.
+The valid arguments to this directive are:
-The valid arguments to this Directive are:
+.I auto
+\- attempt to guess the device type from the device name or from
+controller type info provided by the operating system or from
+a matching USB ID entry in the drive database.
+This is the default.
.I ata
\- the device type is ATA. This prevents
\fBsmartd\fP
from issuing SCSI commands to an ATA device.
+.\" %IF NOT OS Darwin
.I scsi
\- the device type is SCSI. This prevents
\fBsmartd\fP
from issuing ATA commands to a SCSI device.
-.I sat
+.I sat[,auto][,N]
\- the device type is SCSI to ATA Translation (SAT).
-\fBsmartd\fP
-will generate ATA (smart) commands and then package them in
-the SAT defined ATA PASS THROUGH SCSI commands. The commands
-are then routed through the SCSI pass through interface to the
-operating system. There are two types of ATA PASS THROUGH
-SCSI commands: a 12 byte and 16 byte variant.
-\fBsmartd\fP
-can use either and defaults to the 16 byte variant. This can
-be overridden with this syntax: \'\-d sat,12\' or \'\-d sat,16\'.
-
+This is for ATA disks that have a SCSI to ATA Translation (SAT) Layer
+(SATL) between the disk and the operating system.
+SAT defines two ATA PASS THROUGH SCSI commands, one 12 bytes long and
+the other 16 bytes long. The default is the 16 byte variant which can be
+overridden with either \'\-d sat,12\' or \'\-d sat,16\'.
+
+If \'\-d sat,auto\' is specified, device type SAT (for ATA/SATA disks) is
+only used if the SCSI INQUIRY data reports a SATL (VENDOR: "ATA ").
+Otherwise device type SCSI (for SCSI/SAS disks) is used.
+
+.I usbcypress
+\- this device type is for ATA disks that are behind a Cypress USB to PATA
+bridge. This will use the ATACB proprietary scsi pass through command.
+The default SCSI operation code is 0x24, but although it can be overridden
+with \'\-d usbcypress,0xN\', where N is the scsi operation code,
+you're running the risk of damage to the device or filesystems on it.
+
+.I usbjmicron[,p][,x][,PORT]
+\- this device type is for SATA disks that are behind a JMicron USB to
+PATA/SATA bridge. The 48-bit ATA commands (required e.g. for \'\-l xerror\',
+see below) do not work with all of these bridges and are therefore disabled by
+default. These commands can be enabled by \'\-d usbjmicron,x\'.
+If two disks are connected to a bridge with two ports, an error message is printed
+if no PORT is specified.
+The port can be specified by \'\-d usbjmicron[,x],PORT\' where PORT is 0
+(master) or 1 (slave). This is not necessary if the device uses a port
+multiplier to connect multiple disks to one port. The disks appear under
+separate /dev/ice names then.
+CAUTION: Specifying \',x\' for a device which does not support it results
+in I/O errors and may disconnect the drive. The same applies if the specified
+PORT does not exist or is not connected to a disk.
+
+[NEW EXPERIMENTAL SMARTD FEATURE]
+The Prolific PL2507/3507 USB bridges with older firmware support a pass-through
+command similar to JMicron and work with \'\-d usbjmicron,0\'.
+Newer Prolific firmware requires a modified command which can be selected by
+\'\-d usbjmicron,p\'.
+Note that this does not yet support the SMART status command.
+
+.I usbsunplus
+\- this device type is for SATA disks that are behind a SunplusIT USB to SATA
+bridge.
+
+.\" %ENDIF NOT OS Darwin
+.\" %IF OS Linux
.I marvell
-\- Under Linux, interact with SATA disks behind Marvell chip-set
+\- [Linux only] interact with SATA disks behind Marvell chip-set
controllers (using the Marvell rather than libata driver).
.I megaraid,N
-\- the device consists of one or more SCSI/SAS/SATA disks connected
-to a MegaRAID controller. The non-negative integer N (in the range
-of 0 to 127 inclusive) denotes which disk on the controller is monitored.
+\- [Linux only] the device consists of one or more SCSI/SAS disks connected
+to a MegaRAID controller. The non-negative integer N (in the range of 0 to
+127 inclusive) denotes which disk on the controller is monitored.
+This interface will also work for Dell PERC controllers.
In log files and email messages this disk will be identified as
megaraid_disk_XXX with XXX in the range from 000 to 127 inclusive.
-
+It is possible to set RAID device name as /dev/bus/N, where N is a SCSI bus
+number.
+Please see the \fBsmartctl\fP(8) man page for further details.
+
+.I aacraid,H,L,ID
+\- [Linux only] [NEW EXPERIMENTAL SMARTD FEATURE]
+the device consists of one or more SCSI/SAS disks connected to an AacRaid controller.
+The non-negative integers H,L,ID (Host number, Lun, ID) denote which disk
+on the controller is monitored.
+In log files and email messages this disk will be identified as aacraid_disk_HH_LL_ID.
+Please see the \fBsmartctl\fP(8) man page for further details.
+
+.\" %ENDIF OS Linux
+.\" %IF OS FreeBSD Linux
.I 3ware,N
-\- the device consists of one or more ATA disks connected to a 3ware
-RAID controller. The non-negative integer N (in the range from 0 to 127
-inclusive) denotes which disk on the controller is monitored. In log
-files and email messages this disk will be identified as 3ware_disk_XXX
+\- [FreeBSD and Linux only] the device consists of one or more ATA disks
+connected to a 3ware RAID controller. The non-negative integer N
+(in the range from 0 to 127 inclusive) denotes which disk on the controller
+is monitored.
+In log files and email messages this disk will be identified as 3ware_disk_XXX
with XXX in the range from 000 to 127 inclusive.
-This Directive may at first appear confusing, because the 3ware
-controller is a SCSI device (such as /dev/sda) and should be listed as
-such in the the configuration file.
-However when the \'\-d 3ware,N\'
-Directive is used, then the corresponding disk is addressed using
-native ATA commands which are \'passed through\' the SCSI driver. All
-ATA Directives listed in this man page may be used. Note that while
-you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to
-address \fBany\fP of the physical disks (3ware ports), error and log
+Note that while you may use \fBany\fP of the 3ware SCSI logical devices /dev/tw*
+to address \fBany\fP of the physical disks (3ware ports), error and log
messages will make the most sense if you always list the 3ware SCSI
-logical device corresponding to the particular physical disks. Please
-see the \fBsmartctl\fP(8) man page for further details.
-
-ATA disks behind 3ware controllers may alternatively be accessed via a
-character device interface /dev/twe0-15 (3ware 6000/7000/8000
-controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note
-that the 9000 series controllers may \fBonly\fP be accessed using the
-character device interface /dev/twa0-15 and not the SCSI device
-interface /dev/sd?. Please see the \fBsmartctl\fP(8) man page for
-further details.
-
-Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'
-(\fB-S on\fP) and \'Enable Automatic Offline\' (\fB-o on\fP) commands
-to the disk, if the SCSI interface is used, and produce these types of
-harmless syslog error messages instead: \fB\'3w-xxxx: tw_ioctl():
-Passthru size (123392) too big\'\fP. This can be fixed by upgrading to
-version 1.02.00.037 or later of the 3w-xxxx driver, or by applying a
-patch to older versions. See
-\fBhttp://smartmontools.sourceforge.net/\fP for instructions.
-Alternatively use the character device interfaces /dev/twe0-15 (3ware
-6/7/8000 series controllers) or /dev/twa0-15 (3ware 9000 series
-controllers).
+logical device corresponding to the particular physical disks.
+Please see the \fBsmartctl\fP(8) man page for further details.
+.\" %ENDIF OS FreeBSD Linux
+.\" %IF OS FreeBSD Linux Windows Cygwin
.I areca,N
-\- the device consists of one or more SATA disks connected to an Areca
-SATA RAID controller. The positive integer N (in the range from 1 to
-24 inclusive) denotes which disk on the controller is monitored. In
-log files and email messages this disk will be identifed as
+\- [FreeBSD, Linux, Windows and Cygwin only] the device consists of one or more SATA disks
+connected to an Areca SATA RAID controller. The positive integer N (in the range
+from 1 to 24 inclusive) denotes which disk on the controller is monitored.
+In log files and email messages this disk will be identifed as
areca_disk_XX with XX in the range from 01 to 24 inclusive.
+Please see the \fBsmartctl\fP(8) man page for further details.
+.I areca,N/E
+\- [FreeBSD, Linux, Windows and Cygwin only] [NEW EXPERIMENTAL SMARTD FEATURE] the
+device consists of one or more SATA or SAS disks connected to an Areca SAS RAID controller.
+The integer N (range 1 to 128) denotes the channel (slot) and E (range
+1 to 8) denotes the enclosure.
+Important: This requires Areca SAS controller firmware version 1.51 or later.
+
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
+.\" %IF OS FreeBSD Linux
.I cciss,N
-\- the device consists of one or more SCSI disks connected to a cciss
-RAID controller. The non-negative integer N (in the range from 0 to 15
-inclusive) denotes which disk on the controller is monitored. In log
-files and email messages this disk will be identified as cciss_disk_XX
+\- [FreeBSD and Linux only] the device consists of one or more SCSI/SAS or SATA disks
+connected to a cciss RAID controller. The non-negative integer N (in the range
+from 0 to 15 inclusive) denotes which disk on the controller is monitored.
+In log files and email messages this disk will be identified as cciss_disk_XX
with XX in the range from 00 to 15 inclusive.
-
-.B 3ware, MegaRAID, Areca and cciss controllers are currently ONLY supported under Linux.
+Please see the \fBsmartctl\fP(8) man page for further details.
.I hpt,L/M/N
-\- the device consists of one or more ATA disks connected to a HighPoint
-RocketRAID controller. The integer L is the controller id, the integer M
-is the channel number, and the integer N is the PMPort number if it is
-available. The allowed values of L are from 1 to 4 inclusive, M are from
-1 to 8 inclusive and N from 1 to 4 if PMPort available. And also these
-values are limited by the model of the HighPoint RocketRAID controller.
+\- [FreeBSD and Linux only] the device consists of one or more ATA disks
+connected to a HighPoint RocketRAID controller. The integer L is the
+controller id, the integer M is the channel number, and the integer N
+is the PMPort number if it is available. The allowed values of L are
+from 1 to 4 inclusive, M are from 1 to 128 inclusive and N from 1 to 4
+if PMPort available. And also these values are limited by the model
+of the HighPoint RocketRAID controller.
In log files and email messages this disk will be identified as
hpt_X/X/X and X/X/X is the same as L/M/N, note if no N indicated, N set
to the default value 1.
+Please see the \fBsmartctl\fP(8) man page for further details.
-.B HighPoint RocketRAID controllers are currently ONLY supported under Linux and FreeBSD.
+.\" %ENDIF OS FreeBSD Linux
+.I ignore
+\- [NEW EXPERIMENTAL SMARTD FEATURE]
+the device specified by this configuration entry should be ignored.
+This allows to ignore specific devices which are detected by a following
+DEVICESCAN configuration line.
+It may also be used to temporary disable longer multi-line configuration entries.
+This Directive may be used in conjunction with the other \'\-d\' Directives.
.I removable
\- the device or its media is removable. This indicates to
behavior) if the device does not appear to be present when
\fBsmartd\fP is started. This Directive may be used in conjunction
with the other \'\-d\' Directives.
-
.TP
.B \-n POWERMODE[,N][,q]
-This \'nocheck\' Directive is used to prevent a disk from being
-spun-up when it is periodically polled by \fBsmartd\fP.
+[ATA only] This \'nocheck\' Directive is used to prevent a disk from
+being spun-up when it is periodically polled by \fBsmartd\fP.
ATA disks have five different power states. In order of increasing
power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',
and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the
disk\'s platters are not spinning. But usually, in response to SMART
commands issued by \fBsmartd\fP, the disk platters are spun up. So if
-this option is not used, then a disk which is in a low\-power mode may
-be spun up and put into a higher\-power mode when it is periodically
+this option is not used, then a disk which is in a low-power mode may
+be spun up and put into a higher-power mode when it is periodically
polled by \fBsmartd\fP.
Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,
then it won't respond to \fBsmartd\fP commands, and so the disk won't
be registered as a device for \fBsmartd\fP to monitor. If a disk is in
-any other low\-power mode, then the commands issued by \fBsmartd\fP to
-register the disk will probably cause it to spin\-up.
+any other low-power mode, then the commands issued by \fBsmartd\fP to
+register the disk will probably cause it to spin-up.
The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s
periodic checks should still be carried out when the device is in a
-low\-power mode. It may be used to prevent a disk from being spun\-up
+low-power mode. It may be used to prevent a disk from being spun-up
by periodic \fBsmartd\fP polling. The allowed values of POWERMODE
are:
.I never
\- \fBsmartd\fP will poll (check) the device regardless of its power
-mode. This may cause a disk which is spun\-down to be spun\-up when
+mode. This may cause a disk which is spun-down to be spun-up when
\fBsmartd\fP checks it. This is the default behavior if the '\-n'
Directive is not given.
This prevents a laptop disk from spinning up due to this message.
Both \',N\' and \',q\' can be specified together.
-
.TP
.B \-T TYPE
Specifies how tolerant
.I permissive
\- try to monitor the disk even if it appears to lack SMART
capabilities. This may be required for some old disks (prior to
-ATA\-3 revision 4) that implemented SMART before the SMART standards
-were incorporated into the ATA/ATAPI Specifications. This may also be
-needed for some Maxtor disks which fail to comply with the ATA
-Specifications and don't properly indicate support for error\- or
-self\-test logging.
-
+ATA-3 revision 4) that implemented SMART before the SMART standards
+were incorporated into the ATA/ATAPI Specifications.
[Please see the \fBsmartctl \-T\fP command-line option.]
.TP
.B \-o VALUE
-Enables or disables SMART Automatic Offline Testing when
+[ATA only] Enables or disables SMART Automatic Offline Testing when
\fBsmartd\fP
starts up and has no further effect. The valid arguments to this
Directive are \fIon\fP and \fIoff\fP.
[Please see the \fBsmartctl \-S\fP command-line option.]
.TP
.B \-H
-Check the SMART health status of the disk. If any Prefailure
+[ATA only] Check the SMART health status of the disk. If any Prefailure
Attributes are less than or equal to their threshold values, then disk
failure is predicted in less than 24 hours, and a message at loglevel
-.B \'LOG_CRITICAL\'
+.B \'LOG_CRIT\'
will be logged to syslog. [Please see the
.B smartctl \-H
command-line option.]
.TP
.B \-l TYPE
-Reports increases in the number of errors in one of the two SMART logs. The
+Reports increases in the number of errors in one of three SMART logs. The
valid arguments to this Directive are:
.I error
-\- report if the number of ATA errors reported in the ATA Error Log
-has increased since the last check.
+\- [ATA only] report if the number of ATA errors reported in the Summary SMART
+error log has increased since the last check.
+
+.I xerror
+\- [ATA only] report if the number of ATA errors reported in the Extended
+Comprehensive SMART error log has increased since the last check.
+
+If both \'\-l error\' and \'\-l xerror\' are specified, smartd checks
+the maximum of both values.
+
+[Please see the \fBsmartctl \-l xerror\fP command-line option.]
.I selftest
\- report if the number of failed tests reported in the SMART
Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP
and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of
the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP
-command-line option.]
-
+command-line option.
[Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line
options.]
+
+[ATA only] Failed self-tests outdated by a newer successful extended
+self-test are ignored. The warning email counter is reset if the
+number of failed self tests dropped to 0. This typically happens when
+an extended self-test is run after all bad sectors have been reallocated.
+
+.I offlinests[,ns]
+\- [ATA only] report if the Offline Data Collection status has changed
+since the last check. The report will be logged as LOG_CRIT if the new
+status indicates an error. With some drives the status often changes,
+therefore \'\-l offlinests\' is not enabled by '\-a\' Directive.
+.\" %IF NOT OS Cygwin Windows
+.\"! Appending \',ns\' (no standby) to this directive is not implemented
+.\"! on OS_MAN_FILTER.
+.\" %ENDIF NOT OS Cygwin Windows
+.\" %IF OS Cygwin Windows
+
+[Windows and Cygwin only] If \',ns\' (no standby) is appended to this
+directive, smartd disables system auto standby as long as an Offline
+Data Collection is in progress. See \'\-l selfteststs,ns\' below.
+.\" %ENDIF OS Cygwin Windows
+
+.I selfteststs[,ns]
+\- [ATA only] report if the Self-Test execution status has changed
+since the last check. The report will be logged as LOG_CRIT if the new
+status indicates an error.
+.\" %IF NOT OS Cygwin Windows
+.\"! Appending \',ns\' (no standby) to this directive is not implemented
+.\"! on OS_MAN_FILTER.
+.\" %ENDIF NOT OS Cygwin Windows
+.\" %IF OS Cygwin Windows
+
+[Windows and Cygwin only] If \',ns\' (no standby) is appended to this
+directive, smartd disables system auto standby as long as a Self-Test
+is in progress. This prevents that a Self-Test is aborted because the
+OS sets the system to a standby/sleep mode when idle. Smartd check
+interval (\'\-i\' option) should be shorter than the configured idle
+timeout. Auto standby is not disabled if the system is running on
+battery.
+.\" %ENDIF OS Cygwin Windows
+
+.I scterc,READTIME,WRITETIME
+\- [ATA only] sets the SCT Error Recovery Control settings to the specified
+values (deciseconds) when \fBsmartd\fP starts up and has no further effect.
+Values of 0 disable the feature, other values less than 65 are probably
+not supported. For RAID configurations, this is typically set to
+70,70 deciseconds.
+[Please see the \fBsmartctl \-l scterc\fP command-line option.]
+.TP
+.B \-e NAME[,VALUE]
+Sets non-SMART device settings when \fBsmartd\fP starts up and has no
+further effect.
+[Please see the \fBsmartctl \-\-set\fP command-line option.]
+Valid arguments are:
+
+.I aam,[N|off]
+\- [ATA only] Sets the Automatic Acoustic Management (AAM) feature.
+
+.I apm,[N|off]
+\- [ATA only] Sets the Advanced Power Management (APM) feature.
+
+.I lookahead,[on|off]
+\- [ATA only] Sets the read look-ahead feature.
+
+.I security-freeze
+\- [ATA only] Sets ATA Security feature to frozen mode.
+
+.I standby,[N|off]
+\- [ATA only] Sets the standby (spindown) timer and places the drive in the
+IDLE mode.
+
+.I wcache,[on|off]
+\- [ATA only] Sets the volatile write cache feature.
.TP
.B \-s REGEXP
Run Self-Tests or Offline Immediate Tests, at scheduled times. A
soon as a match is found, the test will be started and no additional
matches will be sought for that device and that polling cycle.
-[NEW EXPERIMENTAL SMARTD FEATURE] To run scheduled Selective
-Self-Tests, use \'n\' for \fBn\fPext span, \'r\' to \fBr\fPedo last
-span, or \'c\' to \fBc\fPontinue with next span or redo last span
-based on status of last test. The LBA range is based on the first
-span from the last test.
+To run scheduled Selective Self-Tests, use \'n\' for \fBn\fPext span,
+\'r\' to \fBr\fPedo last span, or \'c\' to \fBc\fPontinue with next span
+or redo last span based on status of last test.
+The LBA range is based on the first span from the last test.
See the \fBsmartctl \-t select,[next|redo|cont]\fP options for
further info.
+Some disks (e.g. WD) do not preserve the selective self test log accross
+power cycles. If state persistence (\'\-s\' option) is enabled, the last
+test span is preserved by smartd and used if (and only if) the selective
+self test log is empty.
.IP \fBMM\fP 4
is the month of the year, expressed with two decimal digits. The
range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP
disk is active again.
Unix users: please beware that the rules for extended regular
-expressions [regex(7)] are \fBnot\fP the same as the rules for
-file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will
+expressions [\fBregex\fP(7)] are \fBnot\fP the same as the rules for
+file-name pattern matching by the shell [\fBglob\fP(7)]. \fBsmartd\fP will
issue harmless informational warning messages if it detects characters
in \fBREGEXP\fP that appear to indicate that you have made this
mistake.
-
.TP
.B \-m ADD
Send a warning email to the email address \fBADD\fP if the \'\-H\',
\fBsmartd\fP
startup.
-By default, email is sent using the system
-.B mail
-command. In order that
-\fBsmartd\fP
-find the mail command (normally /bin/mail) an executable named
-.B \'mail\'
-must be in the path of the shell or environment from which
+By default, email is sent using the system \fBmail\fP(1) command.
+In order that \fBsmartd\fP find this command (normally /usr/bin/mail) the
+executable must be in the path of the shell or environment from which
\fBsmartd\fP
was started. If you wish to specify an explicit path to the mail
executable (for example /usr/local/bin/mail) or a custom script to
run, please use the \'\-M exec\' Directive below.
-Note that by default under Solaris, in the previous paragraph,
-\'\fBmailx\fP\' and \'\fB/bin/mailx\fP\' are used, since Solaris
-\'/bin/mail\' does not accept a \'\-s\' (Subject) command-line
-argument.
-
+.\" %IF OS Windows
On Windows, the \'\fBBlat\fP\' mailer
(\fBhttp://blat.sourceforge.net/\fP) is used by default.
This mailer uses a different command line syntax, see
\'\-M exec\' below.
+.\" %ENDIF OS Windows
Note also that there is a special argument
.B <nomailer>
which can be given to the \'\-m\' Directive in conjunction with the \'\-M
you have mail problems, we recommend running \fBsmartd\fP in debug
mode with the \'-d\' flag, using the \'-M test\' Directive described
below.
-
-The following extension is available on Windows:
-By specifying \'\fBmsgbox\fP\' as a mail address, a warning
-"email" is displayed as a message box on the screen.
-Using both \'\fBmsgbox\fP\' and regular mail addresses is possible,
-if \'\fBmsgbox\fP\' is the first word in the comma separated list.
-With \'\fBsysmsgbox\fP\', a system modal (always on top) message box
-is used. If running as a service, a service notification message box
-(always shown on current visible desktop) is used.
-
+.\" %IF ENABLE_SMARTDPLUGINDIR
+.\" %IF NOT OS Windows
+
+[NEW EXPERIMENTAL SMARTD FEATURE]
+If a word of the comma separated list has the form \'@plugin\', a custom
+script /usr/local/etc/smartd_warning.d/plugin is run and the word is
+removed from the list before sending mail. The string \'plugin\' may be any
+valid name except \'ALL\'.
+If \'@ALL\' is specified, all scripts in /usr/local/etc/smartd_warning.d/*
+are run instead.
+This is handled by the script /usr/local/etc/smartd_warning.sh
+(see also \'\-M exec\' below).
+.\" %ENDIF NOT OS Windows
+.\" %ENDIF ENABLE_SMARTDPLUGINDIR
+.\" %IF OS Windows
+
+[Windows only] [NEW EXPERIMENTAL SMARTD FEATURE]
+If one of the following words are used as the first address in the
+comma separated list, warning messages are sent via WTSSendMessage().
+This displays message boxes on the desktops of the selected sessions.
+Address \'\fBconsole\fP\' specifies the console session only,
+\'\fBactive\fP\' specifies the console session and all active remote
+sessions, and \'\fBconnected\fP\' specifies the console session and
+all connected (active or waiting for login) remote sessions.
+This is handled by the script EXEDIR/smartd_warning.cmd which runs
+the tool EXEDIR/wtssendmsg.exe (see also \'\-M exec\' below).
+The addresses \'\fBmsgbox\fP\' and \'\fBsysmsgbox\fP\' are now
+deprecated and have the same effect as \'\fBconsole\fP\'.
+.\" %ENDIF OS Windows
.TP
.B \-M TYPE
These Directives modify the behavior of the
.I once
\- send only one warning email for each type of disk problem detected. This
-is the default.
+is the default unless state persistence (\'\-s\' option) is enabled.
.I daily
\- send additional warning reminder emails, once per day, for each type
-of disk problem detected.
+of disk problem detected. This is the default if state persistence
+(\'\-s\' option) is enabled.
.I diminishing
\- send additional warning reminder emails, after a one-day interval,
type of disk problem detected. Each interval is twice as long as the
previous interval.
+If a disk problem is no longer detected, the internal email counter is
+reset. If the problem reappears a new warning email is sent immediately.
+
In addition, one may add zero or more of the following Directives:
.I test
\fBsmartd\fP
needs to send email. PATH must point to an executable binary file or
script.
+.\" %IF OS Windows
+
+[Windows only] The PATH may contain space characters.
+Then it must be included in double quotes.
+.\" %ENDIF OS Windows
By setting PATH to point to a customized script, you can make
\fBsmartd\fP perform useful tricks when a disk problem is detected
(beeping the console, shutting down the machine, broadcasting warnings
to all logged-in users, etc.) But please be careful. \fBsmartd\fP
will \fBblock\fP until the executable PATH returns, so if your
-executable hangs, then \fBsmartd\fP will also hang. Some sample
-scripts are included in
-/usr/local/share/doc/smartmontools-5.1/examplescripts/.
+executable hangs, then \fBsmartd\fP will also hang.
+.\" %IF NOT OS Windows
+Some sample scripts are included in
+/usr/local/share/doc/smartmontools/examplescripts/.
+.\" %ENDIF NOT OS Windows
The return status of the executable is recorded by \fBsmartd\fP in
SYSLOG. The executable is not expected to write to STDOUT or
.RS 7
.IP \fBSMARTD_MAILER\fP 4
is set to the argument of \-M exec, if present or else to \'mail\'
-(examples: /bin/mail, mail).
+(examples: /usr/local/bin/mail, mail).
.IP \fBSMARTD_DEVICE\fP 4
is set to the device path (examples: /dev/hda, /dev/sdb).
.IP \fBSMARTD_DEVICETYPE\fP 4
-is set to the device type (possible values: ata, scsi, 3ware,N,
-areca,N, hpt,L/M/N). Here N=0,...,127 denotes the ATA disk behind a
-3ware RAID controller and L/M/N denotes the SATA disk behind a
-HighPoint RocketRAID controller.
+is set to the device type specified by \'-d\' directive or
+\'auto\' if none.
.IP \fBSMARTD_DEVICESTRING\fP 4
is set to the device description. For SMARTD_DEVICETYPE of ata or
scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers,
the form used is \'/dev/sdc [3ware_disk_01]\'. For HighPoint
RocketRAID controller, the form is \'/dev/sdd [hpt_1/1/1]\' under Linux
or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Areca controllers, the
-form is \'/dev/sg2 [areca_disk_09]\'. In these cases the device string
+form is \'/dev/sg2 [areca_disk_09]\' on Linux or \'/dev/arcmsr0 [areca_disk_09]\' on FreeBSD. In these cases the device string
contains a space and is NOT quoted. So to use $SMARTD_DEVICESTRING in a
-bash script you should probably enclose it in double quotes.
+shell script you should probably enclose it in double quotes.
+.IP \fBSMARTD_DEVICEINFO\fP 4
+is set to device identify information. It includes most of the info printed
+by \fBsmartctl \-i\fP but uses a brief single line format.
+This device info is also logged when \fBsmartd\fP starts up.
+The string contains space characters and is NOT quoted.
.IP \fBSMARTD_FAILTYPE\fP 4
gives the reason for the warning or message email. The possible values that
it takes and their meanings are:
-.nf
-.fi
+.br
\fIEmailTest\fP: this is an email test message.
-.nf
-.fi
+.br
\fIHealth\fP: the SMART health status indicates imminent failure.
-.nf
-.fi
+.br
\fIUsage\fP: a usage Attribute has failed.
-.nf
-.fi
+.br
\fISelfTest\fP: the number of self-test failures has increased.
-.nf
-.fi
+.br
\fIErrorCount\fP: the number of errors in the ATA error log has increased.
-.nf
-.fi
+.br
\fICurrentPendingSector\fP: one of more disk sectors could not be
read and are marked to be reallocated (replaced with spare sectors).
-.nf
-.fi
-\fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing,
+.br
+\fIOfflineUncorrectableSector\fP: during off-line testing, or self-testing,
one or more disk sectors could not be read.
-.nf
-.fi
+.br
+\fITemperature\fP: Temperature reached critical limit (see \-W directive).
+.br
\fIFailedHealthCheck\fP: the SMART health status command failed.
-.nf
-.fi
+.br
\fIFailedReadSmartData\fP: the command to read SMART Attribute data failed.
-.nf
-.fi
+.br
\fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed.
-.nf
-.fi
+.br
\fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed.
-.nf
-.fi
+.br
\fIFailedOpenDevice\fP: the open() command to the device failed.
.IP \fBSMARTD_ADDRESS\fP 4
is determined by the address argument ADD of the \'\-m\' Directive.
given by the argument ADD, with the commas replaced by spaces
(example:admin@example.com root). If more than one email address is
given, then this string will contain space characters and is NOT
-quoted, so to use it in a bash script you may want to enclose it in
+quoted, so to use it in a shell script you may want to enclose it in
double quotes.
+.\" %IF OS Windows
+.IP \fBSMARTD_ADDRCSV\fP 4
+[Windows only] is set to a comma-separated list of the addresses from
+SMARTD_ADDRESS.
+.\" %ENDIF OS Windows
.IP \fBSMARTD_MESSAGE\fP 4
is set to the one sentence summary warning email message string from
\fBsmartd\fP.
This message string contains space characters and is NOT quoted. So to
-use $SMARTD_MESSAGE in a bash script you should probably enclose it in
+use $SMARTD_MESSAGE in a shell script you should probably enclose it in
double quotes.
+.\" %IF NOT OS Windows
.IP \fBSMARTD_FULLMESSAGE\fP 4
is set to the contents of the entire email warning message string from
\fBsmartd\fP.
This message string contains space and return characters and is NOT quoted. So to
-use $SMARTD_FULLMESSAGE in a bash script you should probably enclose it in
+use $SMARTD_FULLMESSAGE in a shell script you should probably enclose it in
double quotes.
+.\" %ENDIF NOT OS Windows
+.\" %IF OS Windows
+.IP \fBSMARTD_FULLMSGFILE\fP 4
+[Windows only] is the path to a temporary file containing the full message.
+The path may contain space characters and is NOT quoted.
+The file is created by the smartd_warning.cmd script and removed when
+the mailer or command exits.
+.\" %ENDIF OS Windows
.IP \fBSMARTD_TFIRST\fP 4
is a text string giving the time and date at which the first problem
of this type was reported. This text string contains space characters
and no newlines, and is NOT quoted. For example:
-.nf
-.fi
+.br
Sun Feb 9 14:58:19 2003 CST
.IP \fBSMARTD_TFIRSTEPOCH\fP 4
is an integer, which is the unix epoch (number of seconds since Jan 1,
1970) for \fBSMARTD_TFIRST\fP.
+.IP \fBSMARTD_PREVCNT\fP 4
+is an integer specifying the number of previous messages sent.
+It is set to \'0\' for the first message.
+.IP \fBSMARTD_NEXTDAYS\fP 4
+is an integer specifying the number of days until the next message will be sent.
+It it set to empty on \'\-M once\' and set to \'1\' on \'\-M daily\'.
.RE
.\" The following two lines are a workaround for a man2html bug. Please leave them.
.\" They define a non-existent option; useful because man2html can't correctly reset the margins.
.fi
that would normally be provided to \'mail\'. Examples include:
.nf
-.B -m user@home -M exec /bin/mail
+.B -m user@home -M exec /usr/bin/mail
.B -m admin@work -M exec /usr/local/bin/mailto
-.B -m root -M exec /Example_1/bash/script/below
+.B -m root -M exec /Example_1/shell/script/below
.fi
-Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is
+.\" %IF OS Windows
+[Windows only] On Windows, the syntax of the \'\fBBlat\fP\' mailer is
used:
.nf
-- -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS"
+- -q -subject "%SMARTD_SUBJECT%" -to %SMARTD_ADDRCSV%
.fi
+.\" %ENDIF OS Windows
If the \'\-m ADD\' Directive is given with the special address argument
.B <nomailer>
then the executable pointed to by PATH is run in a shell with
.B no
command-line arguments, for example:
.nf
-.B -m <nomailer> -M exec /Example_2/bash/script/below
+.B -m <nomailer> -M exec /Example_2/shell/script/below
.fi
If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP
assumes that something is going wrong, and a snippet of that output
discarded.
Some EXAMPLES of scripts that can be used with the \'\-M exec\'
-Directive are given below. Some sample scripts are also included in
-/usr/local/share/doc/smartmontools-5.1/examplescripts/.
-
+Directive are given below.
+.\" %IF NOT OS Windows
+Some sample scripts are also included in
+/usr/local/share/doc/smartmontools/examplescripts/.
+.\" %ENDIF NOT OS Windows
+
+[NEW EXPERIMENTAL SMARTD FEATURE] The executable is run by the script
+.\" %IF NOT OS Windows
+/usr/local/etc/smartd_warning.sh.
+.\" %ENDIF NOT OS Windows
+.\" %IF OS ALL
+(Windows: EXEDIR/smartd_warning.cmd)
+.\" %ENDIF OS ALL
+.\" %IF OS Windows
+.\"! EXEDIR/smartd_warning.cmd.
+.\" %ENDIF OS Windows
+This script formats subject and full message based on SMARTD_MESSAGE and other
+environment variables set by \fBsmartd\fP.
+The environment variables
+.\" %IF NOT OS Windows
+SMARTD_SUBJECT and SMARTD_FULLMESSAGE
+.\" %ENDIF NOT OS Windows
+.\" %IF OS ALL
+(Windows: SMARTD_SUBJECT, SMARTD_FULLMSGFILE and SMARTD_ADDRCSV)
+.\" %ENDIF OS ALL
+.\" %IF OS Windows
+.\"! SMARTD_SUBJECT, SMARTD_FULLMSGFILE and SMARTD_ADDRCSV
+.\" %ENDIF OS Windows
+are set by the script before running the executable.
.TP
.B \-f
-Check for \'failure\' of any Usage Attributes. If these Attributes are
-less than or equal to the threshold, it does NOT indicate imminent
-disk failure. It "indicates an advisory condition where the usage or
-age of the device has exceeded its intended design life period."
+[ATA only] Check for \'failure\' of any Usage Attributes. If these
+Attributes are less than or equal to the threshold, it does NOT indicate
+imminent disk failure. It "indicates an advisory condition where the usage
+or age of the device has exceeded its intended design life period."
[Please see the \fBsmartctl \-A\fP command-line option.]
.TP
.B \-p
-Report anytime that a Prefail Attribute has changed
-its value since the last check, 30 minutes ago. [Please see the
+[ATA only] Report anytime that a Prefail Attribute has changed
+its value since the last check. [Please see the
.B smartctl \-A
command-line option.]
.TP
.B \-u
-Report anytime that a Usage Attribute has changed its value
-since the last check, 30 minutes ago. [Please see the
+[ATA only] Report anytime that a Usage Attribute has changed its value
+since the last check. [Please see the
.B smartctl \-A
command-line option.]
.TP
.B \-t
-Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
+[ATA only] Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.
Tracks changes in \fIall\fP device Attributes (both Prefailure and
Usage). [Please see the \fBsmartctl\fP \-A command-line option.]
.TP
.B \-i ID
-Ignore device Attribute number \fBID\fP when checking for failure of
-Usage Attributes. \fBID\fP must be a decimal integer in the range
+[ATA only] Ignore device Attribute number \fBID\fP when checking for failure
+of Usage Attributes. \fBID\fP must be a decimal integer in the range
from 1 to 255. This Directive modifies the behavior of the \'\-f\'
Directive and has no effect without it.
times for a single device, if you want to ignore multiple Attributes.
.TP
.B \-I ID
-Ignore device Attribute \fBID\fP when tracking changes in the
+[ATA only] Ignore device Attribute \fBID\fP when tracking changes in the
Attribute values. \fBID\fP must be a decimal integer in the range
from 1 to 255. This Directive modifies the behavior of the \'\-p\',
\'\-u\', and \'\-t\' tracking Directives and has no effect without one
times for a single device, if you want to ignore multiple Attributes.
.TP
.B \-r ID[!]
-When tracking, report the \fIRaw\fP value of Attribute \fBID\fP along
-with its (normally reported) \fINormalized\fP value. \fBID\fP must be
-a decimal integer in the range from 1 to 255. This Directive modifies
+[ATA only] When tracking, report the \fIRaw\fP value of Attribute \fBID\fP
+along with its (normally reported) \fINormalized\fP value. \fBID\fP must
+be a decimal integer in the range from 1 to 255. This Directive modifies
the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives
and has no effect without one of them. This Directive may be given
multiple times.
If the optional flag \'!\' is appended, a change of the Normalized
value is considered critical. The report will be logged as LOG_CRIT
-and a warning email will be sent if \'-m\' is specified.
-
+and a warning email will be sent if \'\-m\' is specified.
.TP
.B \-R ID[!]
-When tracking, report whenever the \fIRaw\fP value of Attribute
+[ATA only] When tracking, report whenever the \fIRaw\fP value of Attribute
\fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes
of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal
integer in the range from 1 to 255. This Directive modifies the
If the optional flag \'!\' is appended, a change of the Raw
value is considered critical. The report will be logged as
-LOG_CRIT and a warning email will be sent if \'-m\' is specified.
+LOG_CRIT and a warning email will be sent if \'\-m\' is specified.
An example is \'-R 5!\' to warn when new sectors are reallocated.
-
.TP
.B \-C ID[+]
[ATA only] Report if the current number of pending sectors is
\fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to
\fB\-C 197\fP (since Attribute 197 is generally used to monitor
-pending sectors).
+pending sectors). If the name of this Attribute is changed by a
+\'\-v 197,FORMAT,NAME\' directive, the default is changed to
+\fB\-C 0\fP.
If \'+\' is specified, a report is only printed if the number of sectors
has increased between two check cycles. Some disks do not reset this
attribute when a bad sector is reallocated.
See also \'\-v 197,increasing\' below.
+The warning email counter is reset if the number of pending sectors
+dropped to 0. This typically happens when all pending sectors have
+been reallocated or could be read again.
+
A pending sector is a disk sector (containing 512 bytes of your data)
which the device would like to mark as ``bad" and reallocate.
Typically this is because your computer tried to read that sector, and
force the sector to reallocate by writing to it (translation: make the
device substitute a spare good sector for the bad one) but at the
price of losing the 512 bytes of data stored there.
-
.TP
.B \-U ID[+]
[ATA only] Report if the number of offline uncorrectable sectors is
\fBID\fP is 0 to 255 inclusive. To turn off this reporting, use
ID\ =\ 0. If the \fB\-U ID\fP option is not given, then it defaults to
\fB\-U 198\fP (since Attribute 198 is generally used to monitor
-offline uncorrectable sectors).
+offline uncorrectable sectors). If the name of this Attribute is changed
+by a \'\-v 198,FORMAT,NAME\' (except \'\-v 198,FORMAT,Offline_Scan_UNC_SectCt\'),
+directive, the default is changed to \fB\-U 0\fP.
If \'+\' is specified, a report is only printed if the number of sectors
has increased since the last check cycle. Some disks do not reset this
attribute when a bad sector is reallocated.
See also \'\-v 198,increasing\' below.
+The warning email counter is reset if the number of offline uncorrectable
+sectors dropped to 0. This typically happens when all offline uncorrectable
+sectors have been reallocated or could be read again.
+
An offline uncorrectable sector is a disk sector which was not
-readable during an off\-line scan or a self\-test. This is important
+readable during an off-line scan or a self-test. This is important
to know, because if you have data stored in this disk sector, and you
need to read it, the read will fail. Please see the previous \'\-C\'
option for more details.
-
.TP
.B \-W DIFF[,INFO[,CRIT]]
Report if the current temperature had changed by at least \fBDIFF\fP
Report or Warn if the temperature is greater or equal than one of
\fBINFO\fP or \fBCRIT\fP degrees Celsius.
If the limit \fBCRIT\fP is reached, a message with loglevel
-\fB\'LOG_CRITICAL\'\fP will be logged to syslog and a warning email
-will be send if '-m' is specified. If only the limit \fBINFO\fP is
+\fB\'LOG_CRIT\'\fP will be logged to syslog and a warning email
+will be send if \'\-m\' is specified. If only the limit \fBINFO\fP is
reached, a message with loglevel \fB\'LOG_INFO\'\fP will be logged.
+The warning email counter is reset if the temperature dropped below
+\fBINFO\fP or \fBCRIT\fP-5 if \fBINFO\fP is not specified.
+
If this directive is used in conjunction with state persistence
(\'\-s\' option), the min and max temperature values are preserved
across boot cycles. The minimum temperature value is not updated
To track temperature changes of at least 2 degrees, use:
.nf
-\fB \-W 2
+.B \-W 2
.fi
To log informal messages on temperatures of at least 40 degrees, use:
.nf
-\fB \-W 0,40
+.B \-W 0,40
.fi
For warning messages/mails on temperatures of at least 45 degrees, use:
.nf
-\fB \-W 0,0,45
+.B \-W 0,0,45
.fi
To combine all of the above reports, use:
.nf
-\fB \-W 2,40,45
+.B \-W 2,40,45
.fi
-For ATA devices, smartd interprets Attribute 194 as Temperature Celsius
+For ATA devices, smartd interprets Attribute 194 or 190 as Temperature Celsius
by default. This can be changed to Attribute 9 or 220 by the drive
-database or by the \'-v\' directive, see below.
-
+database or by the \'\-v 9,temp\' or \'\-v 220,temp\' directive.
.TP
.B \-F TYPE
-[ATA only] Modifies the behavior of \fBsmartd\fP to compensate for
-some known and understood device firmware bug. The arguments to this
-Directive are exclusive, so that only the final Directive given is
-used. The valid values are:
+[ATA only] Modifies the behavior of \fBsmartd\fP to compensate for some
+known and understood device firmware bug. This directive may be used
+multiple times. The valid arguments are:
.I none
-\- Assume that the device firmware obeys the ATA specifications. This is
-the default, unless the device has presets for \'\-F\' in the device
-database.
+\- Assume that the device firmware obeys the ATA specifications. This
+is the default, unless the device has presets for \'\-F\' in the
+drive database. Using this directive will override any preset values.
+
+.I nologdir
+\- Suppresses read attempts of SMART or GP Log Directory.
+Support for all standard logs is assumed without an actual check.
+Some Intel SSDs may freeze if log address 0 is read.
.I samsung
\- In some Samsung disks (example: model SV4012H Firmware Version:
(3) strange and impossible values for the ATA error log timestamps.
.I samsung2
-\- In more recent Samsung disks (firmware revisions ending in "\-23") the
-number of ATA errors reported is byte swapped. Enabling this option
-tells \fBsmartd\fP to evaluate this quantity in byte-reversed order.
+\- In some Samsung disks the number of ATA errors reported is byte swapped.
+Enabling this option tells \fBsmartd\fP to evaluate this quantity in
+byte-reversed order.
.I samsung3
-\- Some Samsung disks (at least SP2514N with Firmware VF100\-37) report
-a self\-test still in progress with 0% remaining when the test was already
+\- Some Samsung disks (at least SP2514N with Firmware VF100-37) report
+a self-test still in progress with 0% remaining when the test was already
completed. If this directive is specified, \fBsmartd\fP will not skip the
-next scheduled self\-test (see Directive \'\-s\' above) in this case.
-
-Note that an explicit \'\-F\' Directive will over-ride any preset
-values for \'\-F\' (see the \'\-P\' option below).
+next scheduled self-test (see Directive \'\-s\' above) in this case.
+.I xerrorlba
+\- This only affects \fBsmartctl\fP.
[Please see the \fBsmartctl \-F\fP command-line option.]
-
.TP
-.B \-v ID,FORMAT[,NAME]
-[ATA only] Sets a vendor\-specific raw value print FORMAT and
-optional NAME for Attribute ID.
+.B \-v ID,FORMAT[:BYTEORDER][,NAME]
+[ATA only] Sets a vendor-specific raw value print FORMAT, an optional
+BYTEORDER and an optional NAME for Attribute ID.
This directive may be used multiple times.
Please see \fBsmartctl -v\fP command-line option for further details.
.I 198,increasing
\- Raw Attribute number 198 (Offline Uncorrectable Sector Count) is not
-reset if uncorrectable sector are reallocated. This sets \'-U 198+\'
+reset if uncorrectable sectors are reallocated. This sets \'-U 198+\'
if no other \'-U\' directive is specified.
-
.TP
.B \-P TYPE
-Specifies whether
-\fBsmartd\fP
-should use any preset options that are available for this drive. The
-valid arguments to this Directive are:
+[ATA only] Specifies whether \fBsmartd\fP should use any preset options
+that are available for this drive.
+The valid arguments to this Directive are:
.I use
\- use any presets that are available for this drive. This is the default.
[Please see the
.B smartctl \-P
command-line option.]
-
.TP
.B \-a
Equivalent to turning on all of the following Directives:
to report failures of Usage (rather than Prefail) Attributes,
.B \'\-t\'
to track changes in both Prefailure and Usage Attributes,
-.B \'\-l\ selftest\'
-to report increases in the number of Self-Test Log errors,
-.B \'\-l\ error\'
+.B \'\-l\ error\'
to report increases in the number of ATA errors,
+.B \'\-l\ selftest\'
+to report increases in the number of Self-Test Log errors,
+.B \'\-l\ selfteststs\'
+to report changes of Self-Test execution status,
.B \'\-C 197\'
to report nonzero values of the current pending sector count, and
.B \'\-U 198\'
Note that \-a is the default for ATA devices. If none of these other
Directives is given, then \-a is assumed.
-
.TP
.B #
Comment: ignore the remainder of the line.
.TP
.B ADDITIONAL DETAILS ABOUT DEVICESCAN
-If the first non-comment entry in the configuration file is the text
+If a non-comment entry in the configuration file is the text
string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will
ignore any remaining lines in the configuration file, and will scan
-for devices.
+for devices (see also \fBsmartd\fP(8) man page).
If \fBDEVICESCAN\fP is not followed by any Directives, then smartd
will scan for both ATA and SCSI devices, and will monitor all possible
devices, (rather than the default \-a, which monitors all SMART
properties).
+[NEW EXPERIMENTAL SMARTD FEATURE]
+Configuration entries for specific devices may precede the \fBDEVICESCAN\fP entry.
+For example
+.nf
+.B DEFAULT -m root@example.com
+.B /dev/sda -s S/../.././02
+.B /dev/sdc -d ignore
+.B DEVICESCAN -s L/../.././02
+.fi
+will scan for all devices except /dev/sda and /dev/sdc, monitor them, and run a long
+test between 2-3am every morning. Device /dev/sda will also be monitored, but
+only a short test will be run. Device /dev/sdc will be ignored.
+Warning emails will be sent for all monitored devices.
+
.TP
.B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\'
These are two examples of shell scripts that can be used with the \'\-M
.nf
\fB
-#! /bin/bash
+#! /bin/sh
# Save the email message (STDIN) to a file:
cat > /root/msg
/usr/local/sbin/smartctl -a -d $SMART_DEVICETYPE $SMARTD_DEVICE >> /root/msg
# Now email the message to the user at address ADD:
-/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
+/usr/bin/mail -s "$SMARTD_SUBJECT" $SMARTD_ADDRESS < /root/msg
\fP
.fi
.nf
\fB
-#! /bin/bash
+#! /bin/sh
# Warn all users of a problem
-wall \'Problem detected with disk: \' "$SMARTD_DEVICESTRING"
-wall \'Warning message from smartd is: \' "$SMARTD_MESSAGE"
-wall \'Shutting down machine in 30 seconds... \'
-
+wall <<EOF
+Problem detected with disk: $SMARTD_DEVICESTRING
+Warning message from smartd is: $SMARTD_MESSAGE
+Shutting down machine in 30 seconds...
+EOF
+
# Wait half a minute
sleep 30
-
+
# Power down the machine
/sbin/shutdown -hf now
\fP
.fi
Some example scripts are distributed with the smartmontools package,
-in /usr/local/share/doc/smartmontools-5.1/examplescripts/.
+in /usr/local/share/doc/smartmontools/examplescripts/.
Please note that these scripts typically run as root, so any files
that they read/write should not be writable by ordinary users or
within the script, and a snippet of STDOUT/STDERR is logged to SYSLOG.
The remainder is flushed.
-.\" ENDINCLUDE
-.\" DO NOT MODIFY THIS OR PREVIOUS/NEXT LINES. THIS DEFINES THE
-.\" END OF THE INCLUDED SECTION FROM smartd.8.in
-
-.PP
-.SH AUTHOR
-\fBBruce Allen\fP smartmontools-support@lists.sourceforge.net
-.fi
-University of Wisconsin \- Milwaukee Physics Department
-
-.PP
-.SH CONTRIBUTORS
-The following have made large contributions to smartmontools:
-.nf
-\fBCasper Dik\fP (Solaris SCSI interface)
-\fBChristian Franke\fP (Windows interface, C++ redesign, USB support, ...)
-\fBDouglas Gilbert\fP (SCSI subsystem)
-\fBGuido Guenther\fP (Autoconf/Automake packaging)
-\fBGeoffrey Keating\fP (Darwin ATA interface)
-\fBEduard Martinescu\fP (FreeBSD interface)
-\fBFr\*'ed\*'eric L. W. Meunier\fP (Web site and Mailing list)
-\fBGabriele Pohl\fP (Web site and Wiki, conversion from CVS to SVN)
-\fBKeiji Sawada\fP (Solaris ATA interface)
-\fBManfred Schwarb\fP (Drive database)
-\fBSergey Svishchev\fP (NetBSD interface)
-\fBDavid Snyder and Sergey Svishchev\fP (OpenBSD interface)
-\fBPhil Williams\fP (User interface and drive database)
-\fBShengfeng Zhou\fP (Linux/FreeBSD HighPoint RocketRAID interface)
-.fi
-Many other individuals have made smaller contributions and corrections.
-
-.PP
-.SH CREDITS
-.fi
-This code was derived from the smartsuite package, written by Michael
-Cornwell, and from the previous ucsc smartsuite package. It extends
-these to cover ATA-5 disks. This code was originally developed as a
-Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory
-(now part of the Storage Systems Research Center), Jack Baskin School
-of Engineering, University of California, Santa
-Cruz. \fBhttp://ssrc.soe.ucsc.edu/\fP .
-.SH
-HOME PAGE FOR SMARTMONTOOLS:
-.fi
-Please see the following web site for updates, further documentation, bug
-reports and patches:
-.nf
-.B
-http://smartmontools.sourceforge.net/
+.\" %IF NOT OS Windows
+.SH FILES
+.TP
+.B /usr/local/etc/smartd.conf
+full path of this file.
-.SH
-SEE ALSO:
-\fBsmartd\fP(8), \fBsmartctl\fP(8), \fBsyslogd\fP(8),
-\fBsyslog.conf\fP(5), \fBbadblocks\fP(8), \fBide\-smart\fP(8), \fBregex\fP(7).
+.\" %ENDIF NOT OS Windows
+.SH SEE ALSO
+\fBsmartd\fP(8), \fBsmartctl\fP(8),
+\fBmail\fP(1), \fBregex\fP(7).
-.SH
-SVN ID OF THIS PAGE:
-$Id: smartd.conf.5.in 2977 2009-10-30 22:29:05Z chrfranke $
+.SH SVN ID OF THIS PAGE
+$Id: smartd.conf.5.in 3965 2014-07-20 14:46:41Z chrfranke $
projects / mirror_smartmontools-debian.git / blobdiff