version 1.1.1.2, 2012/10/09 09:36:45
|
version 1.1.1.3, 2013/07/22 01:17:36
|
Line 1
|
Line 1
|
.ig |
.ig |
Copyright (C) 2002-10 Bruce Allen <smartmontools-support@lists.sourceforge.net> |
Copyright (C) 2002-10 Bruce Allen <smartmontools-support@lists.sourceforge.net> |
|
Copyright (C) 2004-13 Christian Franke <smartmontools-support@lists.sourceforge.net> |
|
|
$Id$ |
$Id$ |
|
|
This program is free software; you can redistribute it and/or modify it | This program is free software; you can redistribute it and/or modify |
under the terms of the GNU General Public License as published by the Free | it under the terms of the GNU General Public License as published by |
Software Foundation; either version 2, or (at your option) any later | the Free Software Foundation; either version 2, or (at your option) |
version. | any later version. |
|
|
You should have received a copy of the GNU General Public License (for | You should have received a copy of the GNU General Public License |
example COPYING); if not, write to the Free Software Foundation, Inc., 675 | (for example COPYING); If not, see <http://www.gnu.org/licenses/>. |
Mass Ave, Cambridge, MA 02139, USA. | |
|
|
This code was originally developed as a Senior Thesis by Michael Cornwell |
This code was originally developed as a Senior Thesis by Michael Cornwell |
at the Concurrent Systems Laboratory (now part of the Storage Systems |
at the Concurrent Systems Laboratory (now part of the Storage Systems |
Research Center), Jack Baskin School of Engineering, University of |
Research Center), Jack Baskin School of Engineering, University of |
California, Santa Cruz. http://ssrc.soe.ucsc.edu/ |
California, Santa Cruz. http://ssrc.soe.ucsc.edu/ |
|
|
.. |
.. |
.TH SMARTD.CONF 5 CURRENT_SVN_DATE CURRENT_SVN_VERSION CURRENT_SVN_DATE |
.TH SMARTD.CONF 5 CURRENT_SVN_DATE CURRENT_SVN_VERSION CURRENT_SVN_DATE |
.SH NAME |
.SH NAME |
Line 36 CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
|
Line 37 CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
|
.\"! .PP |
.\"! .PP |
.\" %ENDIF NOT OS ALL |
.\" %ENDIF NOT OS ALL |
\fB/usr/local/etc/smartd.conf\fP is the configuration file for the \fBsmartd\fP |
\fB/usr/local/etc/smartd.conf\fP is the configuration file for the \fBsmartd\fP |
daemon, which monitors the Self-Monitoring, Analysis and Reporting | daemon. |
Technology (SMART) system built into many ATA-3 and later ATA, IDE and | |
SCSI-3 hard drives. | |
|
|
If the configuration file \fB/usr/local/etc/smartd.conf\fP is present, |
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 |
\fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the |
Line 49 re-read the configuration file. This signal can be gen
|
Line 48 re-read the configuration file. This signal can be gen
|
\fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is |
\fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is |
running. |
running. |
|
|
.SH CONFIGURATION FILE /usr/local/etc/smartd.conf |
|
In the absence of a configuration file |
In the absence of a configuration file |
\fBsmartd\fP will try to open all available devices. | \fBsmartd\fP will try to open all available devices |
.\" %IF OS Linux | (see \fBsmartd\fP(8) man page). |
Under linux \fBsmartd\fP will try to open the 20 ATA devices | A configuration file with a single line \fB\'DEVICESCAN \-a'\fP |
.B /dev/hd[a-t] | would have the same effect. |
and the 26 SCSI devices | |
.B /dev/sd[a-z]. | |
.\" %ENDIF OS Linux | |
.\" %IF OS FreeBSD | |
Under FreeBSD, | |
\fBsmartd\fP | |
will try to open all existing ATA/SATA devices (using ATA subsystem) | |
.B /dev/ad[0-9]+ | |
and all existing SCSI/SAS/AHCI devices (using CAM subsystem). | |
.\" %ENDIF OS FreeBSD | |
.\" %IF OS NetBSD OpenBSD | |
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. | |
.\" %ENDIF OS NetBSD OpenBSD | |
.\" %IF OS Solaris | |
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. | |
.\" %ENDIF OS Solaris | |
.\" %IF OS Windows | |
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. | |
.\" %ENDIF OS Windows | |
.\" %IF OS Darwin | |
Under Darwin, \fBsmartd\fP will open any ATA block storage device. | |
.\" %ENDIF OS Darwin | |
|
|
This can be annoying if you have an ATA or SCSI device that hangs or |
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 |
misbehaves when receiving SMART commands. Even if this causes no |
problems, you may be annoyed by the string of error log messages about | problems, you may be annoyed by the string of error log messages about devices |
block-major devices that can\'t be found, and SCSI devices that can\'t | that can\'t be opened. |
be opened. | |
|
|
One can avoid this problem, and gain more control over the types of |
One can avoid this problem, and gain more control over the types of |
events monitored by |
events monitored by |
Line 176 Section below!
|
Line 141 Section below!
|
.B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01 |
.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,1 -a -s S/../.././02 |
.B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03 |
.B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03 |
|
.B \ \ /dev/bus/0 -d megaraid,2 -a -s S/../.././03 |
.B |
.B |
.B # |
.B # |
.\" %ENDIF OS Linux |
.\" %ENDIF OS Linux |
Line 202 Section below!
|
Line 168 Section below!
|
.B # Two SATA (not SAS) disks on a 3ware 9750 controller. |
.B # Two SATA (not SAS) disks on a 3ware 9750 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 # 1am and 2-3 am |
|
.\" %IF OS Linux |
.B \ \ /dev/twl0 -d 3ware,0 -a -s L/../../7/00 |
.B \ \ /dev/twl0 -d 3ware,0 -a -s L/../../7/00 |
.B \ \ /dev/twl0 -d 3ware,1 -a -s L/../../7/02 |
.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 # |
.nf |
.nf |
.B # Three SATA disks on a HighPoint RocketRAID controller. |
.B # Three SATA disks on a HighPoint RocketRAID controller. |
Line 341 status fails, or if new errors appear in the self-test
|
Line 313 status fails, or if new errors appear in the self-test
|
|
|
.B If a 3ware controller is used |
.B If a 3ware controller is used |
then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?, |
then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?, |
/dev/twa? or /dev/twl?) must be listed, along with the \'\-d 3ware,N\' | /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 |
Directive (see below). The individual ATA disks hosted by the 3ware |
controller appear to \fBsmartd\fP as normal ATA devices. Hence all |
controller appear to \fBsmartd\fP as normal ATA devices. Hence all |
the ATA directives can be used for these disks (but see note below). |
the ATA directives can be used for these disks (but see note below). |
Line 362 Specifies the type of the device.
|
Line 334 Specifies the type of the device.
|
The valid arguments to this directive are: |
The valid arguments to this directive are: |
|
|
.I auto |
.I auto |
- attempt to guess the device type from the device name or from | \- attempt to guess the device type from the device name or from |
controller type info provided by the operating system or from |
controller type info provided by the operating system or from |
a matching USB ID entry in the drive database. |
a matching USB ID entry in the drive database. |
This is the default. |
This is the default. |
Line 386 SAT defines two ATA PASS THROUGH SCSI commands, one 12
|
Line 358 SAT defines two ATA PASS THROUGH SCSI commands, one 12
|
the other 16 bytes long. The default is the 16 byte variant which can be |
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\'. |
overridden with either \'\-d sat,12\' or \'\-d sat,16\'. |
|
|
[NEW EXPERIMENTAL SMARTD FEATURE] If \'-d sat,auto\' is specified, | If \'\-d sat,auto\' is specified, device type SAT (for ATA/SATA disks) is |
device type SAT (for ATA/SATA disks) is | |
only used if the SCSI INQUIRY data reports a SATL (VENDOR: "ATA "). |
only used if the SCSI INQUIRY data reports a SATL (VENDOR: "ATA "). |
Otherwise device type SCSI (for SCSI/SAS disks) is used. |
Otherwise device type SCSI (for SCSI/SAS disks) is used. |
|
|
Line 398 The default SCSI operation code is 0x24, but although
|
Line 369 The default SCSI operation code is 0x24, but although
|
with \'\-d usbcypress,0xN\', where N is the scsi operation code, |
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. |
you're running the risk of damage to the device or filesystems on it. |
|
|
.I usbjmicron | .I usbjmicron[,p][,x][,PORT] |
- this device type is for SATA disks that are behind a JMicron USB to | \- 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\', |
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 |
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\'. |
default. These commands can be enabled by \'\-d usbjmicron,x\'. |
Line 413 CAUTION: Specifying \',x\' for a device which does not
|
Line 384 CAUTION: Specifying \',x\' for a device which does not
|
in I/O errors and may disconnect the drive. The same applies if the specified |
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. |
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 |
.I usbsunplus |
\- this device type is for SATA disks that are behind a SunplusIT USB to SATA |
\- this device type is for SATA disks that are behind a SunplusIT USB to SATA |
bridge. |
bridge. |
Line 430 to a MegaRAID controller. The non-negative integer N
|
Line 408 to a MegaRAID controller. The non-negative integer N
|
This interface will also work for Dell PERC controllers. |
This interface will also work for Dell PERC controllers. |
In log files and email messages this disk will be identified as |
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. |
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. |
Please see the \fBsmartctl\fP(8) man page for further details. |
|
|
.\" %ENDIF OS Linux |
.\" %ENDIF OS Linux |
Line 460 Please see the \fBsmartctl\fP(8) man page for further
|
Line 440 Please see the \fBsmartctl\fP(8) man page for further
|
|
|
.I areca,N/E |
.I areca,N/E |
\- [FreeBSD, Linux, Windows and Cygwin only] [NEW EXPERIMENTAL SMARTD FEATURE] the |
\- [FreeBSD, Linux, Windows and Cygwin only] [NEW EXPERIMENTAL SMARTD FEATURE] the |
device consists of one or more SATA disks connected to an Areca SAS RAID controller. | 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 |
The integer N (range 1 to 128) denotes the channel (slot) and E (range |
1 to 8) denotes the enclosure. |
1 to 8) denotes the enclosure. |
Important: This requires upcoming Areca SAS controller firmware version 1.51 or a | Important: This requires Areca SAS controller firmware version 1.51 or later. |
recent beta version. | |
|
|
.\" %ENDIF OS FreeBSD Linux Windows Cygwin |
.\" %ENDIF OS FreeBSD Linux Windows Cygwin |
.\" %IF OS FreeBSD Linux |
.\" %IF OS FreeBSD Linux |
Line 490 to the default value 1.
|
Line 469 to the default value 1.
|
Please see the \fBsmartctl\fP(8) man page for further details. |
Please see the \fBsmartctl\fP(8) man page for further details. |
|
|
.\" %ENDIF OS FreeBSD Linux |
.\" %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 |
.I removable |
\- the device or its media is removable. This indicates to |
\- the device or its media is removable. This indicates to |
\fBsmartd\fP |
\fBsmartd\fP |
Line 507 power consumption they are: \'OFF\', \'SLEEP\', \'STAN
|
Line 494 power consumption they are: \'OFF\', \'SLEEP\', \'STAN
|
and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the |
and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the |
disk\'s platters are not spinning. But usually, in response to SMART |
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 |
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 | 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 | be spun up and put into a higher-power mode when it is periodically |
polled by \fBsmartd\fP. |
polled by \fBsmartd\fP. |
|
|
Note that if the disk is in SLEEP mode when \fBsmartd\fP is started, |
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 |
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 |
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 | any other low-power mode, then the commands issued by \fBsmartd\fP to |
register the disk will probably cause it to spin\-up. | register the disk will probably cause it to spin-up. |
|
|
The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s |
The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s |
periodic checks should still be carried out when the device is in a |
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 |
by periodic \fBsmartd\fP polling. The allowed values of POWERMODE |
are: |
are: |
|
|
.I never |
.I never |
\- \fBsmartd\fP will poll (check) the device regardless of its power |
\- \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' |
\fBsmartd\fP checks it. This is the default behavior if the '\-n' |
Directive is not given. |
Directive is not given. |
|
|
Line 568 continue if an optional SMART command fails. This is
|
Line 555 continue if an optional SMART command fails. This is
|
.I permissive |
.I permissive |
\- try to monitor the disk even if it appears to lack SMART |
\- try to monitor the disk even if it appears to lack SMART |
capabilities. This may be required for some old disks (prior to |
capabilities. This may be required for some old disks (prior to |
ATA\-3 revision 4) that implemented SMART before the SMART standards | ATA-3 revision 4) that implemented SMART before the SMART standards |
were incorporated into the ATA/ATAPI Specifications. This may also be | were incorporated into the ATA/ATAPI Specifications. |
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. | |
| |
[Please see the \fBsmartctl \-T\fP command-line option.] |
[Please see the \fBsmartctl \-T\fP command-line option.] |
.TP |
.TP |
.B \-o VALUE |
.B \-o VALUE |
Line 638 command-line option.
|
Line 621 command-line option.
|
options.] |
options.] |
|
|
[ATA only] Failed self-tests outdated by a newer successful extended |
[ATA only] Failed self-tests outdated by a newer successful extended |
self\-test are ignored. The warning email counter is reset if the | self-test are ignored. The warning email counter is reset if the |
number of failed self tests dropped to 0. This typically happens when |
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. | an extended self-test is run after all bad sectors have been reallocated. |
|
|
.I offlinests[,ns] |
.I offlinests[,ns] |
\- [ATA only] report if the Offline Data Collection status has changed |
\- [ATA only] report if the Offline Data Collection status has changed |
Line 686 not supported. For RAID configurations, this is typic
|
Line 669 not supported. For RAID configurations, this is typic
|
[Please see the \fBsmartctl \-l scterc\fP command-line option.] |
[Please see the \fBsmartctl \-l scterc\fP command-line option.] |
|
|
.TP |
.TP |
.B -e NAME[,VALUE] | .B \-e NAME[,VALUE] |
[NEW EXPERIMENTAL SMARTD FEATURE] Sets non\-SMART device settings | Sets non-SMART device settings when \fBsmartd\fP starts up and has no |
when \fBsmartd\fP starts up and has no further effect. | further effect. |
[Please see the \fBsmartctl \-\-set\fP command-line option.] |
[Please see the \fBsmartctl \-\-set\fP command-line option.] |
Valid arguments are: |
Valid arguments are: |
|
|
Line 837 disk is active again.
|
Line 820 disk is active again.
|
|
|
Unix users: please beware that the rules for extended regular |
Unix users: please beware that the rules for extended regular |
expressions [regex(7)] are \fBnot\fP the same as the rules for |
expressions [regex(7)] are \fBnot\fP the same as the rules for |
file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will | file-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will |
issue harmless informational warning messages if it detects characters |
issue harmless informational warning messages if it detects characters |
in \fBREGEXP\fP that appear to indicate that you have made this |
in \fBREGEXP\fP that appear to indicate that you have made this |
mistake. |
mistake. |
Line 903 sending mail, this should help you to understand and f
|
Line 886 sending mail, this should help you to understand and f
|
you have mail problems, we recommend running \fBsmartd\fP in debug |
you have mail problems, we recommend running \fBsmartd\fP in debug |
mode with the \'-d\' flag, using the \'-M test\' Directive described |
mode with the \'-d\' flag, using the \'-M test\' Directive described |
below. |
below. |
|
.\" %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 |
.\" %IF OS Windows |
.\" %IF OS Windows |
|
|
The following extension is available on Windows: | [Windows only] [NEW EXPERIMENTAL SMARTD FEATURE] |
By specifying \'\fBmsgbox\fP\' as a mail address, a warning | If one of the following words are used as the first address in the |
"email" is displayed as a message box on the screen. | comma separated list, warning messages are sent via WTSSendMessage(). |
Using both \'\fBmsgbox\fP\' and regular mail addresses is possible, | This displays message boxes on the desktops of the selected sessions. |
if \'\fBmsgbox\fP\' is the first word in the comma separated list. | Address \'\fBconsole\fP\' specifies the console session only, |
With \'\fBsysmsgbox\fP\', a system modal (always on top) message box | \'\fBactive\fP\' specifies the console session and all active remote |
is used. | sessions, and \'\fBconnected\fP\' specifies the console session and |
| all connected (active or waiting for login) remote sessions. |
If running as a service, a service notification message box | This is handled by the script EXEDIR/smartd_warning.cmd which runs |
(always shown on current visible desktop) is used. Please note that | the tool EXEDIR/wtssendmsg.exe (see also \'\-M exec\' below). |
service notification message boxes are no longer supported on Windows | The addresses \'\fBmsgbox\fP\' and \'\fBsysmsgbox\fP\' are now |
Vista/2008 or later. | deprecated and have the same effect as \'\fBconsole\fP\'. |
.\" %ENDIF OS Windows |
.\" %ENDIF OS Windows |
.TP |
.TP |
.B \-M TYPE |
.B \-M TYPE |
Line 968 in addition to the single test email!
|
Line 963 in addition to the single test email!
|
\fBsmartd\fP |
\fBsmartd\fP |
needs to send email. PATH must point to an executable binary file or |
needs to send email. PATH must point to an executable binary file or |
script. |
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 |
By setting PATH to point to a customized script, you can make |
\fBsmartd\fP perform useful tricks when a disk problem is detected |
\fBsmartd\fP perform useful tricks when a disk problem is detected |
(beeping the console, shutting down the machine, broadcasting warnings |
(beeping the console, shutting down the machine, broadcasting warnings |
to all logged-in users, etc.) But please be careful. \fBsmartd\fP |
to all logged-in users, etc.) But please be careful. \fBsmartd\fP |
will \fBblock\fP until the executable PATH returns, so if your |
will \fBblock\fP until the executable PATH returns, so if your |
executable hangs, then \fBsmartd\fP will also hang. Some sample | executable hangs, then \fBsmartd\fP will also hang. |
scripts are included in | .\" %IF NOT OS Windows |
| Some sample scripts are included in |
/usr/local/share/doc/smartmontools/examplescripts/. |
/usr/local/share/doc/smartmontools/examplescripts/. |
|
.\" %ENDIF NOT OS Windows |
|
|
The return status of the executable is recorded by \fBsmartd\fP in |
The return status of the executable is recorded by \fBsmartd\fP in |
SYSLOG. The executable is not expected to write to STDOUT or |
SYSLOG. The executable is not expected to write to STDOUT or |
Line 1008 or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Arec
|
Line 1010 or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Arec
|
form is \'/dev/sg2 [areca_disk_09]\' on Linux or \'/dev/arcmsr0 [areca_disk_09]\' on FreeBSD. 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 |
contains a space and is NOT quoted. So to use $SMARTD_DEVICESTRING in a |
bash script you should probably enclose it in double quotes. |
bash 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 |
.IP \fBSMARTD_FAILTYPE\fP 4 |
gives the reason for the warning or message email. The possible values that |
gives the reason for the warning or message email. The possible values that |
it takes and their meanings are: |
it takes and their meanings are: |
Line 1032 it takes and their meanings are:
|
Line 1039 it takes and their meanings are:
|
read and are marked to be reallocated (replaced with spare sectors). |
read and are marked to be reallocated (replaced with spare sectors). |
.nf |
.nf |
.fi |
.fi |
\fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing, | \fIOfflineUncorrectableSector\fP: during off-line testing, or self-testing, |
one or more disk sectors could not be read. |
one or more disk sectors could not be read. |
.nf |
.nf |
.fi |
.fi |
Line 1061 given by the argument ADD, with the commas replaced by
|
Line 1068 given by the argument ADD, with the commas replaced by
|
given, then this string will contain space characters and is NOT |
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 bash script you may want to enclose it in |
double quotes. |
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 |
.IP \fBSMARTD_MESSAGE\fP 4 |
is set to the one sentence summary warning email message string from |
is set to the one sentence summary warning email message string from |
\fBsmartd\fP. |
\fBsmartd\fP. |
This message string contains space characters and is NOT quoted. So to |
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 bash script you should probably enclose it in |
double quotes. |
double quotes. |
|
.\" %IF NOT OS Windows |
.IP \fBSMARTD_FULLMESSAGE\fP 4 |
.IP \fBSMARTD_FULLMESSAGE\fP 4 |
is set to the contents of the entire email warning message string from |
is set to the contents of the entire email warning message string from |
\fBsmartd\fP. |
\fBsmartd\fP. |
This message string contains space and return characters and is NOT quoted. So to |
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 bash script you should probably enclose it in |
double quotes. |
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 |
.IP \fBSMARTD_TFIRST\fP 4 |
is a text string giving the time and date at which the first problem |
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 |
of this type was reported. This text string contains space characters |
Line 1083 Sun Feb 9 14:58:19 2003 CST
|
Line 1104 Sun Feb 9 14:58:19 2003 CST
|
.IP \fBSMARTD_TFIRSTEPOCH\fP 4 |
.IP \fBSMARTD_TFIRSTEPOCH\fP 4 |
is an integer, which is the unix epoch (number of seconds since Jan 1, |
is an integer, which is the unix epoch (number of seconds since Jan 1, |
1970) for \fBSMARTD_TFIRST\fP. |
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 |
.RE |
.\" The following two lines are a workaround for a man2html bug. Please leave them. |
.\" 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. |
.\" They define a non-existent option; useful because man2html can't correctly reset the margins. |
Line 1107 that would normally be provided to \'mail\'. Examples
|
Line 1134 that would normally be provided to \'mail\'. Examples
|
.fi |
.fi |
|
|
.\" %IF OS Windows |
.\" %IF OS Windows |
Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is | [Windows only] On Windows, the syntax of the \'\fBBlat\fP\' mailer is |
used: |
used: |
.nf |
.nf |
- -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS" | - -q -subject "%SMARTD_SUBJECT%" -to %SMARTD_ADDRCSV% |
.fi |
.fi |
|
|
.\" %ENDIF OS Windows |
.\" %ENDIF OS Windows |
Line 1130 will be copied to SYSLOG. The remainder of the output
|
Line 1157 will be copied to SYSLOG. The remainder of the output
|
discarded. |
discarded. |
|
|
Some EXAMPLES of scripts that can be used with the \'\-M exec\' |
Some EXAMPLES of scripts that can be used with the \'\-M exec\' |
Directive are given below. Some sample scripts are also included in | Directive are given below. |
| .\" %IF NOT OS Windows |
| Some sample scripts are also included in |
/usr/local/share/doc/smartmontools/examplescripts/. |
/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 |
.TP |
.B \-f |
.B \-f |
[ATA only] Check for \'failure\' of any Usage Attributes. If these |
[ATA only] Check for \'failure\' of any Usage Attributes. If these |
Line 1193 A common use of this Directive is to track the device
|
Line 1248 A common use of this Directive is to track the device
|
|
|
If the optional flag \'!\' is appended, a change of the Normalized |
If the optional flag \'!\' is appended, a change of the Normalized |
value is considered critical. The report will be logged as LOG_CRIT |
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 |
.TP |
.B \-R ID[!] |
.B \-R ID[!] |
[ATA only] When tracking, report whenever the \fIRaw\fP value of Attribute |
[ATA only] When tracking, report whenever the \fIRaw\fP value of Attribute |
Line 1215 Attributes.
|
Line 1270 Attributes.
|
|
|
If the optional flag \'!\' is appended, a change of the Raw |
If the optional flag \'!\' is appended, a change of the Raw |
value is considered critical. The report will be logged as |
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. |
An example is \'-R 5!\' to warn when new sectors are reallocated. |
.TP |
.TP |
.B \-C ID[+] |
.B \-C ID[+] |
Line 1271 sectors dropped to 0. This typically happens when all
|
Line 1326 sectors dropped to 0. This typically happens when all
|
sectors have been reallocated or could be read again. |
sectors have been reallocated or could be read again. |
|
|
An offline uncorrectable sector is a disk sector which was not |
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 |
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\' |
need to read it, the read will fail. Please see the previous \'\-C\' |
option for more details. |
option for more details. |
Line 1283 Report or Warn if the temperature is greater or equal
|
Line 1338 Report or Warn if the temperature is greater or equal
|
\fBINFO\fP or \fBCRIT\fP degrees Celsius. |
\fBINFO\fP or \fBCRIT\fP degrees Celsius. |
If the limit \fBCRIT\fP is reached, a message with loglevel |
If the limit \fBCRIT\fP is reached, a message with loglevel |
\fB\'LOG_CRIT\'\fP will be logged to syslog and a warning email |
\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 | 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. |
reached, a message with loglevel \fB\'LOG_INFO\'\fP will be logged. |
|
|
The warning email counter is reset if the temperature dropped below |
The warning email counter is reset if the temperature dropped below |
Line 1315 To combine all of the above reports, use:
|
Line 1370 To combine all of the above reports, use:
|
.B \-W 2,40,45 |
.B \-W 2,40,45 |
.fi |
.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 |
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 |
.TP |
.B \-F TYPE |
.B \-F TYPE |
[ATA only] Modifies the behavior of \fBsmartd\fP to compensate for | [ATA only] Modifies the behavior of \fBsmartd\fP to compensate for some |
some known and understood device firmware bug. The arguments to this | known and understood device firmware bug. This directive may be used |
Directive are exclusive, so that only the final Directive given is | multiple times. The valid arguments are: |
used. The valid values are: | |
|
|
.I none |
.I none |
\- Assume that the device firmware obeys the ATA specifications. This |
\- Assume that the device firmware obeys the ATA specifications. This |
is the default, unless the device has presets for \'\-F\' in the |
is the default, unless the device has presets for \'\-F\' in the |
device database. | drive database. Using this directive will over-ride 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 |
.I samsung |
\- In some Samsung disks (example: model SV4012H Firmware Version: |
\- In some Samsung disks (example: model SV4012H Firmware Version: |
RM100\-08) some of the two\- and four\-byte quantities in the SMART data | RM100-08) some of the two- and four-byte quantities in the SMART data |
structures are byte\-swapped (relative to the ATA specification). | structures are byte-swapped (relative to the ATA specification). |
Enabling this option tells \fBsmartd\fP to evaluate these quantities |
Enabling this option tells \fBsmartd\fP to evaluate these quantities |
in byte\-reversed order. Some signs that your disk needs this option | in byte-reversed order. Some signs that your disk needs this option |
are (1) no self\-test log printed, even though you have run self\-tests; | are (1) no self-test log printed, even though you have run self-tests; |
(2) very large numbers of ATA errors reported in the ATA error log; |
(2) very large numbers of ATA errors reported in the ATA error log; |
(3) strange and impossible values for the ATA error log timestamps. |
(3) strange and impossible values for the ATA error log timestamps. |
|
|
.I samsung2 |
.I samsung2 |
\- In some Samsung disks the number of ATA errors reported is byte swapped. |
\- In some Samsung disks the number of ATA errors reported is byte swapped. |
Enabling this option tells \fBsmartd\fP to evaluate this quantity in |
Enabling this option tells \fBsmartd\fP to evaluate this quantity in |
byte\-reversed order. | byte-reversed order. |
|
|
.I samsung3 |
.I samsung3 |
\- Some Samsung disks (at least SP2514N with Firmware VF100\-37) report | \- 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 | 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 |
completed. If this directive is specified, \fBsmartd\fP will not skip the |
next scheduled self\-test (see Directive \'\-s\' above) in this case. | next scheduled self-test (see Directive \'\-s\' above) in this case. |
|
|
Note that an explicit \'\-F\' Directive will over\-ride any preset | .I xerrorlba |
values for \'\-F\' (see the \'\-P\' option below). | \- This only affects \fBsmartctl\fP. |
|
|
|
|
[Please see the \fBsmartctl \-F\fP command-line option.] |
[Please see the \fBsmartctl \-F\fP command-line option.] |
.TP |
.TP |
.B \-v ID,FORMAT[:BYTEORDER][,NAME] |
.B \-v ID,FORMAT[:BYTEORDER][,NAME] |
[ATA only] Sets a vendor\-specific raw value print FORMAT, an optional | [ATA only] Sets a vendor-specific raw value print FORMAT, an optional |
BYTEORDER and an optional NAME for Attribute ID. |
BYTEORDER and an optional NAME for Attribute ID. |
This directive may be used multiple times. |
This directive may be used multiple times. |
Please see \fBsmartctl -v\fP command-line option for further details. |
Please see \fBsmartctl -v\fP command-line option for further details. |
Line 1444 If you want more frequent information, use:
|
Line 1502 If you want more frequent information, use:
|
If a 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 |
string \fBDEVICESCAN\fP in capital letters, then \fBsmartd\fP will |
ignore any remaining lines in the configuration file, and will scan |
ignore any remaining lines in the configuration file, and will scan |
for devices. | for devices (see also \fBsmartd\fP(8) man page). |
|
|
Configuration entries for devices not found by the platform\-specific |
|
device scanning may precede the \fBDEVICESCAN\fP entry. |
|
|
|
If \fBDEVICESCAN\fP is not followed by any Directives, then smartd |
If \fBDEVICESCAN\fP is not followed by any Directives, then smartd |
will scan for both ATA and SCSI devices, and will monitor all possible |
will scan for both ATA and SCSI devices, and will monitor all possible |
SMART properties of any devices that are found. |
SMART properties of any devices that are found. |
Line 1472 will do the same, but only monitors the SMART health s
|
Line 1527 will do the same, but only monitors the SMART health s
|
devices, (rather than the default \-a, which monitors all SMART |
devices, (rather than the default \-a, which monitors all SMART |
properties). |
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 |
.TP |
.B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\' |
.B EXAMPLES OF SHELL SCRIPTS FOR \'\-M exec\' |
These are two examples of shell scripts that can be used with the \'\-M |
These are two examples of shell scripts that can be used with the \'\-M |
Line 1534 within the script, and a snippet of STDOUT/STDERR is l
|
Line 1603 within the script, and a snippet of STDOUT/STDERR is l
|
The remainder is flushed. |
The remainder is flushed. |
|
|
.PP |
.PP |
.SH AUTHOR | .SH AUTHORS |
\fBBruce Allen\fP smartmontools\-support@lists.sourceforge.net | \fBBruce Allen\fP |
.fi | .br |
University of Wisconsin \- Milwaukee Physics Department |
University of Wisconsin \- Milwaukee Physics Department |
|
.br |
|
\fBChristian Franke\fP (Windows interface, C++ redesign, most enhancements |
|
since 2009) |
|
.br |
|
\fBsmartmontools\-support@lists.sourceforge.net\fP |
|
|
.PP |
.PP |
.SH CONTRIBUTORS |
.SH CONTRIBUTORS |
The following have made large contributions to smartmontools: |
The following have made large contributions to smartmontools: |
.nf |
.nf |
\fBCasper Dik\fP (Solaris SCSI interface) |
\fBCasper Dik\fP (Solaris SCSI interface) |
\fBChristian Franke\fP (Windows interface, C++ redesign, USB support, ...) |
|
\fBDouglas Gilbert\fP (SCSI subsystem) |
\fBDouglas Gilbert\fP (SCSI subsystem) |
\fBGuido Guenther\fP (Autoconf/Automake packaging) |
\fBGuido Guenther\fP (Autoconf/Automake packaging) |
\fBGeoffrey Keating\fP (Darwin ATA interface) |
\fBGeoffrey Keating\fP (Darwin ATA interface) |
Line 1565 Many other individuals have made smaller contributions
|
Line 1638 Many other individuals have made smaller contributions
|
.fi |
.fi |
This code was derived from the smartsuite package, written by Michael |
This code was derived from the smartsuite package, written by Michael |
Cornwell, and from the previous UCSC smartsuite package. It extends |
Cornwell, and from the previous UCSC smartsuite package. It extends |
these to cover ATA\-5 disks. This code was originally developed as a | these to cover ATA-5 disks. This code was originally developed as a |
Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory |
Senior Thesis by Michael Cornwell at the Concurrent Systems Laboratory |
(now part of the Storage Systems Research Center), Jack Baskin School |
(now part of the Storage Systems Research Center), Jack Baskin School |
of Engineering, University of California, Santa |
of Engineering, University of California, Santa |