.ig
Copyright (C) 2002-10 Bruce Allen
-Copyright (C) 2004-15 Christian Franke
+Copyright (C) 2004-16 Christian Franke
-$Id: smartctl.8.in 4120 2015-08-27 16:12:21Z samm2 $
+$Id: smartctl.8.in 4311 2016-04-27 21:03:01Z 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
("lsscsi \-g" is helpful in determining which scsi generic device node corresponds
to which device.) Use the nodes corresponding to the RAID controllers,
not the nodes corresponding to logical drives. See the \fB\-d\fP option below, as well.
+Use the forms \fB"/dev/nvme[0\-9]"\fP (broadcast namespace) or
+\fB"/dev/nvme[0\-9]n[1\-9]"\fP (specific namespace 1\-9) for NVMe devices.
.\" %ENDIF OS Linux
.\" %IF OS Darwin
.IP \fBDARWIN\fP: 9
For SATA or SAS disks behind an Areca controller use
\fB"/dev/arcmsr[0\-9]"\fP, see \'\-d areca,N[/E]\' below.
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+Use the forms \fB"/dev/nvme[0\-9]"\fP (broadcast namespace) or
+\fB"/dev/nvme[0\-9]n[1\-9]"\fP (specific namespace 1\-9) for first,
+second, ..., NVMe device.
+Alternatively use the forms \fB"/dev/nvmes[0\-9][n[1\-9]]"\fP for NVMe devices
+behind the logical scsi controller "\\\\.\\Scsi[0\-9]:".
+
The prefix \fB"/dev/"\fP is optional.
.\" %ENDIF OS Windows Cygwin
.\" %IF OS OS2
in the smartmontools database (see \'\-v\' options below). If so, the
drive model family may also be printed. If \'\-n\' (see below) is
specified, the power mode of the drive is printed.
+.\" %IF OS FreeBSD Linux Windows Cygwin
+
+[NVMe] [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+For NVMe devices the information is obtained from the Identify Controller
+and the Identify Namespace data structure.
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
.TP
.B \-\-identify[=[w][nvb]]
[ATA only] Prints an annotated table of the IDENTIFY DEVICE data.
.nf
\'\-H \-i \-A \-l error \-l selftest\'.
.fi
+.\" %IF OS FreeBSD Linux Windows Cygwin
+For NVMe, this is equivalent to
+.nf
+\'\-H \-i \-c \-A \-l error'.
+.fi
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
Note that for ATA disks this does \fBnot\fP enable the non-SMART options
and the SMART options which require support for 48-bit ATA commands.
.TP
.nf
\'\-H \-i \-A \-l error \-l selftest \-l background \-l sasphy\'.
.fi
+.\" %IF OS FreeBSD Linux Windows Cygwin
+For NVMe, this is equivalent to
+.nf
+\'\-H \-i \-c \-A \-l error'.
+.fi
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
.TP
.B \-\-scan
Scans for devices and prints each device name, device type and protocol
.nf
smartctl \-\-scan\-open \-\- \-a \-W 4,45,50 \-m admin@work > smartd.conf
.fi
+
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+Multiple \'\-d TYPE\' options may be specified with \'\-\-scan[\-open]\'
+to combine the scan results of more than one TYPE.
.TP
.B \-g NAME, \-\-get=NAME
Get non-SMART device settings. See \'\-s, \-\-set\' below for further info.
\fBsmartctl\fP
from issuing ATA commands to a SCSI device.
+.\" %ENDIF NOT OS Darwin
+.\" %IF OS FreeBSD Linux Windows Cygwin
+.I nvme[,NSID]
+\- [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+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.
+The default for NSID is the namespace id addressed by the device name.
+
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
+.\" %IF NOT OS Darwin
.I sat[,auto][,N]
\- the device type is SCSI to ATA Translation (SAT).
This is for ATA disks that have a SCSI to ATA Translation (SAT) Layer
it a second time adds a hex listing of the first 64 bytes of data send to,
or received from the device.
+.\" %IF OS FreeBSD Linux Windows Cygwin
+.I nvmeioctl
+\- [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+report only ioctl() transactions with NVMe devices.
+
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
Any argument may include a positive integer to specify the level of detail
that should be reported. The argument should be followed by a comma then
the integer with no spaces. For example,
when the page is read.
This means that each alert condition is reported only once by \fBsmartctl\fP
for each initiator for each activation of the condition.
+.\" %IF OS FreeBSD Linux Windows Cygwin
+
+[NVMe] [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+NVMe status is obtained by reading the "Critical Warning" byte from
+the SMART/Health Information log.
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
.TP
.B \-c, \-\-capabilities
-[ATA only] Prints only the generic SMART capabilities. These
+[ATA] Prints only the generic SMART capabilities. These
show what SMART features are implemented and how the device will
respond to some of the different SMART commands. For example it
shows if the device logs errors, if it supports offline surface
Immediate Offline Test is carried out. Please see REFERENCES below
for further information about the the flags and capabilities described
by this option.
+.\" %IF OS FreeBSD Linux Windows Cygwin
+
+[NVMe] [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+Prints various NVMe device capabilities obtained from the Identify Controller
+and the Identify Namespace data structure.
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
.TP
.B \-A, \-\-attributes
[ATA] Prints only the vendor specific SMART Attributes. The Attributes
and start-stop cycle counter log pages. Certain vendor specific
attributes are listed if recognised. The attributes are output in a
relatively free format (compared with ATA disk attributes).
+.\" %IF OS FreeBSD Linux Windows Cygwin
+
+[NVMe] [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+For NVMe devices the attributes are obtained from the SMART/Health
+Information log.
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
.TP
.B \-f FORMAT, \-\-format=FORMAT
[ATA only] Selects the output format of the attributes:
\- [SCSI] prints the error counter log pages for reads, write and verifies.
The verify row is only output if it has an element other than zero.
+.\" %IF OS FreeBSD Linux Windows Cygwin
+.I error[,NUM]
+\- [NVMe] [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+prints the NVMe Error Information log.
+Only the 16 most recent log entries are printed by default.
+This number can be changed by the optional parameter NUM.
+The maximum number of log entries is vendor specific
+(in the range from 1 to 256 inclusive).
+
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
.I xerror[,NUM][,error]
\- [ATA only] prints the Extended Comprehensive SMART error log
(General Purpose Log address 0x03). Unlike the Summary SMART error
writes a binary representation of the one sector log 0x11
(SATA Phy Event Counters) to file log.bin.
+.\" %IF OS FreeBSD Linux Windows Cygwin
+.I nvmelog,PAGE,SIZE
+\- [NVMe only] [FreeBSD, Linux, Windows and Cygwin only]
+[NEW EXPERIMENTAL SMARTCTL FEATURE]
+prints a hex dump of the first SIZE bytes from the NVMe log with
+identifier PAGE.
+PAGE is a hexadecimal number in the range from 0x1 to 0xff.
+SIZE is a hexadecimal number in the range from 0x4 to 0x4000 (16 KiB).
+\fBWARNING: Do not specify the identifier of an unknown log page.
+Reading a log page may have undesirable side effects.\fP
+
+.\" %ENDIF OS FreeBSD Linux Windows Cygwin
.I ssd
\- [ATA] prints the Solid State Device Statistics log page.
This has the same effect as \'\-l devstat,7\', see above.
.\"! \fBEXEDIR/drivedb.h\fP
.\" %ENDIF OS Windows
is present, the contents of this file is used instead of the built in table.
+.\" %IF ENABLE_UPDATE_SMART_DRIVEDB
Run
.\" %IF NOT OS Windows
.\"! \fBEXEDIR/update-smart-drivedb.exe\fP
.\" %ENDIF OS Windows
to update this file from the smartmontools SVN repository.
+.\" %ENDIF ENABLE_UPDATE_SMART_DRIVEDB
.\" %ENDIF ENABLE_DRIVEDB
The database files use the same C/C++ syntax that is used to initialize
<\fBhttps://lists.sourceforge.net/lists/listinfo/smartmontools-support\fB>.
.SH SEE ALSO
-\fBsmartd\fP(8), \fBupdate-smart-drivedb\fP(8).
+\fBsmartd\fP(8).
+.\" %IF ENABLE_UPDATE_SMART_DRIVEDB
+.br
+\fBupdate-smart-drivedb\fP(8).
+.\" %ENDIF ENABLE_UPDATE_SMART_DRIVEDB
.SH REFERENCES
Please see the following web site for more info:
.SH PACKAGE VERSION
CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV
.br
-$Id: smartctl.8.in 4120 2015-08-27 16:12:21Z samm2 $
+$Id: smartctl.8.in 4311 2016-04-27 21:03:01Z chrfranke $
projects / mirror_smartmontools-debian.git / blobdiff