.ig
Copyright (C) 2002-10 Bruce Allen
-Copyright (C) 2004-17 Christian Franke
+Copyright (C) 2004-18 Christian Franke
-$Id: smartd.conf.5.in 4589 2017-11-04 15:30:54Z chrfranke $
+SPDX-License-Identifier: GPL-2.0-or-later
-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, 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/
+$Id: smartd.conf.5.in 4856 2018-12-11 21:42:16Z chrfranke $
..
.\" Macros borrowed from pages generated with Pod::Man
.TH SMARTD.CONF 5 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools"
.SH NAME
\fBsmartd.conf\fP \- SMART Disk Monitoring Daemon Configuration File\fP
-
+.Sp
.SH DESCRIPTION
.\" %IF NOT OS ALL
.\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools.
################################################
.Ve
.Sp
-.SH CONFIGURATION FILE DIRECTIVES
+.SH DEVICESCAN
If a non-comment entry in the configuration file is the text string
.B DEVICESCAN
in capital letters, then
\fBsmartd\fP
will ignore any remaining lines in the configuration file, and will
scan for devices.
+If
+.B DEVICESCAN
+is not followed by any Directives, then \*(Aq\-a\*(Aq will apply to all
+devices.
+.PP
.B DEVICESCAN
may optionally be followed by Directives that will apply to all
-devices that are found in the scan. Please see below for additional
-details.
+devices that are found in the scan.
+For example
+.PP
+.Vb
+\ \ DEVICESCAN \-m root@example.com
+.Ve
+.PP
+will scan for all devices, and then monitor them.
+It will send one email warning per device for any problems that are found.
+.PP
+.Vb
+\ \ DEVICESCAN \-H \-m root@example.com
+.Ve
+.PP
+will do the same, but only monitors the SMART health status of the
+devices, rather than the default \*(Aq\-a\*(Aq.
+.PP
+Multiple \*(Aq\-d TYPE\*(Aq options may be specified with DEVICESCAN
+to combine the scan results of more than one TYPE.
+.PP
+Configuration entries for specific devices may precede the \fBDEVICESCAN\fP
+entry.
+For example
.PP
+.Vb 4
+\ \ DEFAULT \-m root@example.com
+\ \ /dev/sda \-s S/../.././02
+\ \ /dev/sdc \-d ignore
+\ \ DEVICESCAN \-s L/../.././02
+.Ve
+.PP
+will scan for all devices except /dev/sda and /dev/sdc, monitor them, and
+run a long test between 2\(en3 am 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.
+.PP
+A device is ignored by DEVICESCAN if a configuration line with the same
+device name exists.
+.br
+[NEW EXPERIMENTAL SMARTD FEATURE]
+A device name is also ignored if another device with same identify
+information (vendor, model, firmware version, serial number, WWN) already
+exists.
+.Sp
+.SH DEFAULT SETTINGS
If an entry in the configuration file starts with
.B DEFAULT
instead of a device name, then all directives in this entry are set
\ \ /dev/sdd \-H \-m admin@example.com
\ \ /dev/sde \-d removable \-H \-m admin@example.com
.Ve
-.PP
+.Sp
+.SH CONFIGURATION FILE DIRECTIVES
The following are the Directives that may appear following the device
name or
.B DEVICESCAN
.\" %ENDIF NOT OS Darwin
.\" %IF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.I nvme[,NSID]
-\- [NEW EXPERIMENTAL SMARTCTL FEATURE]
-the device type is NVM Express (NVMe).
+\- the device type is NVM Express (NVMe).
The optional parameter NSID specifies the namespace id (in hex) passed
to the driver.
Use 0xffffffff for the broadcast namespace id.
\- this device type is for SATA disks that are behind a SunplusIT USB to SATA
bridge.
.Sp
+.I sntjmicron[,NSID]
+\- [NEW EXPERIMENTAL SMARTD FEATURE]
+this device type is for NVMe disks that are behind a JMicron USB to NVMe
+bridge.
+The optional parameter NSID specifies the namespace id (in hex) passed
+to the driver.
+The default namespace id is the broadcast namespace id (0xffffffff).
+.Sp
.\" %ENDIF NOT OS Darwin
.\" %IF OS Linux
.I marvell
.\" %IF OS Linux Windows Cygwin
.I aacraid,H,L,ID
\- [Linux, Windows and Cygwin only] the device consists of one or more
-SCSI/SAS disks connected to an AacRaid controller.
+SCSI/SAS or SATA 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
command-line option.]
.\" %IF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.Sp
-[NVMe]
-[NEW EXPERIMENTAL SMARTD FEATURE]
-Checks the "Critical Warning" byte from the SMART/Health Information log.
+[NVMe] Checks the "Critical Warning" byte from the SMART/Health
+Information log.
If any warning bit is set, a message at loglevel \fB\*(AqLOG_CRIT\*(Aq\fP
will be logged to syslog.
.\" %ENDIF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.Sp
.\" %IF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.I error
-\- [NVMe]
-[NEW EXPERIMENTAL SMARTD FEATURE]
-report if the "Number of Error Information Log Entries" from the
+\- [NVMe] report if the "Number of Error Information Log Entries" from the
SMART/Health Information log has increased since the last check.
.Sp
.\" %ENDIF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.Sp
.\" %IF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.I xerror
-\- [NVMe]
-[NEW EXPERIMENTAL SMARTD FEATURE]
-same as \*(Aq\-l error\*(Aq.
+\- [NVMe] same as \*(Aq\-l error\*(Aq.
.\" %ENDIF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.Sp
.I selftest
database or by the \*(Aq\-v 9,temp\*(Aq or \*(Aq\-v 220,temp\*(Aq directive.
.\" %IF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
.Sp
-[NEW EXPERIMENTAL SMARTD FEATURE]
For NVMe devices, smartd checks the maximum of the Composite Temperature value
and all Temperature Sensor values reported by SMART/Health Information log.
.\" %ENDIF OS Darwin FreeBSD Linux NetBSD Windows Cygwin
If you want more frequent information, use: \fB\-a\fP.
.Sp
.TP
-.B ADDITIONAL DETAILS ABOUT DEVICESCAN
-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 (see also \fBsmartd\fP(8) man page).
-.Sp
-If \fBDEVICESCAN\fP is not followed by any Directives, then smartd
-will scan for both ATA and SCSI devices, and will monitor all possible
-SMART properties of any devices that are found.
-.Sp
-\fBDEVICESCAN\fP may optionally be followed by any valid Directives,
-which will be applied to all devices that are found in the scan. For
-example
-.br
-.B DEVICESCAN \-m root@example.com
-.br
-will scan for all devices, and then monitor them. It will send one
-email warning per device for any problems that are found.
-.br
-.B DEVICESCAN \-d ata \-m root@example.com
-.br
-will do the same, but restricts the scan to ATA devices only.
-.br
-.B DEVICESCAN \-H \-d ata \-m root@example.com
-.br
-will do the same, but only monitors the SMART health status of the
-devices, (rather than the default \-a, which monitors all SMART
-properties).
-.br
-[NEW EXPERIMENTAL SMARTD FEATURE]
-Multiple \*(Aq\-d TYPE\*(Aq options may be specified with DEVICESCAN
-to combine the scan results of more than one TYPE.
-.Sp
-Configuration entries for specific devices may precede the \fBDEVICESCAN\fP
-entry.
-For example
-.br
-.B DEFAULT \-m root@example.com
-.br
-.B /dev/sda \-s S/../.././02
-.br
-.B /dev/sdc \-d ignore
-.br
-.B DEVICESCAN \-s L/../.././02
-.br
-will scan for all devices except /dev/sda and /dev/sdc, monitor them, and
-run a long test between 2\(en3 am 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.
-.Sp
-A device is ignored by DEVICESCAN if a configuration line with the same
-device name exists.
-.br
-[NEW EXPERIMENTAL SMARTD FEATURE]
-A device name is also ignored if another device with same identify
-information (vendor, model, firmware version, serial number, WWN) already
-exists.
-.Sp
-.TP
.B EXAMPLES OF SHELL SCRIPTS FOR \*(Aq\-M exec\*(Aq
These are two examples of shell scripts that can be used with the \*(Aq\-M
exec PATH\*(Aq Directive described previously. The paths to these scripts
.SH PACKAGE VERSION
CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
.br
-$Id: smartd.conf.5.in 4589 2017-11-04 15:30:54Z chrfranke $
+$Id: smartd.conf.5.in 4856 2018-12-11 21:42:16Z chrfranke $
projects / mirror_smartmontools-debian.git / blobdiff