]>
Commit | Line | Data |
---|---|---|
832b75ed | 1 | .ig |
293b5ab8 JD |
2 | Copyright (C) 2002-10 Bruce Allen |
3 | Copyright (C) 2004-15 Christian Franke | |
ee38a438 | 4 | |
6b80b4d2 | 5 | $Id: smartctl.8.in 4120 2015-08-27 16:12:21Z samm2 $ |
ee38a438 GI |
6 | |
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 2, or (at your option) | |
10 | any later version. | |
11 | ||
12 | You should have received a copy of the GNU General Public License | |
13 | (for example COPYING); If not, see <http://www.gnu.org/licenses/>. | |
14 | ||
15 | This code was originally developed as a Senior Thesis by Michael Cornwell | |
16 | at the Concurrent Systems Laboratory (now part of the Storage Systems | |
17 | Research Center), Jack Baskin School of Engineering, University of | |
18 | California, Santa Cruz. http://ssrc.soe.ucsc.edu/ | |
832b75ed GG |
19 | |
20 | .. | |
293b5ab8 | 21 | .TH SMARTCTL 8 "CURRENT_SVN_DATE" "CURRENT_SVN_VERSION" "SMART Monitoring Tools" |
832b75ed GG |
22 | .SH NAME |
23 | \fBsmartctl\fP \- Control and Monitor Utility for SMART Disks | |
24 | ||
25 | .SH SYNOPSIS | |
26 | .B smartctl [options] device | |
27 | ||
832b75ed | 28 | .SH DESCRIPTION |
d008864d GI |
29 | .\" %IF NOT OS ALL |
30 | .\"! [This man page is generated for the OS_MAN_FILTER version of smartmontools. | |
31 | .\"! It does not contain info specific to other platforms.] | |
32 | .\"! .PP | |
33 | .\" %ENDIF NOT OS ALL | |
ee38a438 GI |
34 | \fBsmartctl\fP controls the Self-Monitoring, Analysis and |
35 | Reporting Technology (SMART) system built into most ATA/SATA and SCSI/SAS | |
36 | hard drives and solid-state drives. | |
37 | The purpose of SMART is to monitor the reliability of the hard drive | |
38 | and predict drive failures, and to carry out different types of drive | |
39 | self-tests. | |
40 | \fBsmartctl\fP also supports some features not related to SMART. | |
41 | This version of \fBsmartctl\fP is compatible with | |
d2e702cf | 42 | ACS-3, ACS-2, ATA8-ACS, ATA/ATAPI-7 and earlier standards |
ee38a438 | 43 | (see \fBREFERENCES\fP below). |
832b75ed GG |
44 | |
45 | \fBsmartctl\fP also provides support for polling TapeAlert messages | |
46 | from SCSI tape drives and changers. | |
47 | ||
48 | The user must specify the device to be controlled or interrogated as | |
2127e193 GI |
49 | the final argument to \fBsmartctl\fP. The command set used by the device |
50 | is often derived from the device path but may need help with the \'\-d\' | |
51 | option (for more information see the section on "ATA, SCSI command sets | |
52 | and SAT" below). Device paths are as follows: | |
d008864d | 53 | .\" %IF OS Linux |
832b75ed | 54 | .IP \fBLINUX\fP: 9 |
293b5ab8 JD |
55 | Use the forms \fB"/dev/sd[a\-z]"\fP for ATA/SATA and SCSI/SAS devices. |
56 | For SCSI Tape Drives and Changers with TapeAlert support use the | |
57 | devices \fB"/dev/nst*"\fP and \fB"/dev/sg*"\fP. For disks behind | |
2127e193 | 58 | 3ware controllers you may need \fB"/dev/sd[a\-z]"\fP or |
cfbba5b9 | 59 | \fB"/dev/twe[0\-9]"\fP, \fB"/dev/twa[0\-9]"\fP or \fB"/dev/twl[0\-9]"\fP: see details |
2127e193 GI |
60 | below. For disks behind HighPoint RocketRAID controllers you may need |
61 | \fB"/dev/sd[a\-z]"\fP. For disks behind Areca SATA RAID controllers, | |
62 | you need \fB"/dev/sg[2\-9]"\fP (note that smartmontools interacts with | |
63 | the Areca controllers via a SCSI generic device which is different | |
ee38a438 GI |
64 | than the SCSI device used for reading and writing data)! For HP Smart |
65 | Array RAID controllers, there are three currently supported drivers: cciss, | |
66 | hpsa, and hpahcisr. For disks accessed via the cciss driver the device nodes | |
67 | are of the form \fB"/dev/cciss/c[0\-9]d0"\fP. For disks accessed via | |
68 | the hpahcisr and hpsa drivers, the device nodes you need are \fB"/dev/sg[0\-9]*"\fP. | |
69 | ("lsscsi \-g" is helpful in determining which scsi generic device node corresponds | |
70 | to which device.) Use the nodes corresponding to the RAID controllers, | |
71 | not the nodes corresponding to logical drives. See the \fB\-d\fP option below, as well. | |
d008864d GI |
72 | .\" %ENDIF OS Linux |
73 | .\" %IF OS Darwin | |
832b75ed GG |
74 | .IP \fBDARWIN\fP: 9 |
75 | Use the forms \fB/dev/disk[0\-9]\fP or equivalently \fBdisk[0\-9]\fP or equivalently | |
76 | \fB/dev/rdisk[0\-9]\fP. Long forms are also available: please use \'\-h\' to see some | |
77 | examples. Note that there is currently no Darwin SCSI support. | |
f4e463df GI |
78 | |
79 | Use the OS X SAT SMART Driver to access SMART data on SAT capable USB and | |
80 | Firewire devices (see INSTALL file). | |
d008864d GI |
81 | .\" %ENDIF OS Darwin |
82 | .\" %IF OS FreeBSD | |
832b75ed GG |
83 | .IP \fBFREEBSD\fP: 9 |
84 | Use the forms \fB"/dev/ad[0\-9]+"\fP for IDE/ATA | |
cfbba5b9 | 85 | devices and \fB"/dev/da[0\-9]+"\fP or \fB"/dev/pass[0\-9]+"\fP for SCSI devices. |
ee38a438 GI |
86 | For SATA devices on AHCI bus use \fB"/dev/ada[0\-9]+"\fP format. For HP Smart |
87 | Array RAID controllers, use \fB"/dev/ciss[0\-9]"\fP (and see the \fB-d\fP option, | |
88 | below). | |
d008864d GI |
89 | .\" %ENDIF OS FreeBSD |
90 | .\" %IF OS NetBSD OpenBSD | |
832b75ed GG |
91 | .IP \fBNETBSD/OPENBSD\fP: 9 |
92 | Use the form \fB"/dev/wd[0\-9]+c"\fP for IDE/ATA | |
93 | devices. For SCSI disk and tape devices, use the device names | |
94 | \fB"/dev/sd[0\-9]+c"\fP and \fB"/dev/st[0\-9]+c"\fP respectively. | |
95 | Be sure to specify the correct "whole disk" partition letter for | |
96 | your architecture. | |
d008864d GI |
97 | .\" %ENDIF OS NetBSD OpenBSD |
98 | .\" %IF OS Solaris | |
832b75ed GG |
99 | .IP \fBSOLARIS\fP: 9 |
100 | Use the forms \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk | |
101 | devices, and \fB"/dev/rmt/*"\fP for SCSI tape devices. | |
d008864d | 102 | .\" %ENDIF OS Solaris |
d008864d | 103 | .\" %IF OS Windows Cygwin |
ee38a438 | 104 | .IP \fBWINDOWS\fP: 9 |
a37e7145 GG |
105 | Use the forms \fB"/dev/sd[a\-z]"\fP for IDE/(S)ATA and SCSI disks |
106 | "\\\\.\\PhysicalDrive[0\-25]" (where "a" maps to "0"). | |
ee38a438 | 107 | Use \fB"/dev/sd[a\-z][a\-z]"\fP for "\\\\.\\PhysicalDrive[26\-...]". |
a37e7145 GG |
108 | These disks can also be referred to as \fB"/dev/pd[0\-255]"\fP for |
109 | "\\\\.\\PhysicalDrive[0\-255]". | |
110 | ATA disks can also be referred to as \fB"/dev/hd[a\-z]"\fP for | |
111 | "\\\\.\\PhysicalDrive[0\-25]". | |
112 | Use one the forms \fB"/dev/tape[0\-255]"\fP, \fB"/dev/st[0\-255]"\fP, | |
113 | or \fB"/dev/nst[0\-255]"\fP for SCSI tape drives "\\\\.\\Tape[0\-255]". | |
114 | ||
115 | Alternatively, drive letters \fB"X:"\fP or \fB"X:\\"\fP may be used to | |
2127e193 GI |
116 | specify the (\'basic\') disk behind a mounted partition. This does |
117 | not work with \'dynamic\' disks. | |
a37e7145 GG |
118 | |
119 | For disks behind 3ware 9000 controllers use \fB"/dev/sd[a\-z],N"\fP where | |
4d59bff9 | 120 | N specifies the disk number (3ware \'port\') behind the controller |
a37e7145 | 121 | providing the logical drive (\'unit\') specified by \fB"/dev/sd[a\-z]"\fP. |
9ebc753d GG |
122 | Alternatively, use \fB"/dev/tw_cli/cx/py"\fP for controller x, port y |
123 | to run the \'tw_cli\' tool and parse the output. This provides limited | |
a37e7145 | 124 | monitoring (\'\-i\', \'\-c\', \'\-A\' below) if SMART support is missing |
9ebc753d GG |
125 | in the driver. Use \fB"/dev/tw_cli/stdin"\fP or \fB"/dev/tw_cli/clip"\fP |
126 | to parse CLI or 3DM output from standard input or clipboard. | |
a37e7145 | 127 | The option \'\-d 3ware,N\' is not necessary on Windows. |
cfbba5b9 | 128 | |
f4e463df GI |
129 | For disks behind an Intel ICHxR controller with RST driver use |
130 | \fB"/dev/csmi[0\-9],N"\fP where N specifies the port behind the logical | |
131 | scsi controller "\\\\.\\Scsi[0\-9]:". | |
132 | ||
293b5ab8 JD |
133 | For SATA or SAS disks behind an Areca controller use |
134 | \fB"/dev/arcmsr[0\-9]"\fP, see \'\-d areca,N[/E]\' below. | |
f4e463df | 135 | |
832b75ed | 136 | The prefix \fB"/dev/"\fP is optional. |
d008864d | 137 | .\" %ENDIF OS Windows Cygwin |
d008864d | 138 | .\" %IF OS OS2 |
832b75ed GG |
139 | .IP \fBOS/2,eComStation\fP: 9 |
140 | Use the form \fB"/dev/hd[a\-z]"\fP for IDE/ATA devices. | |
d008864d | 141 | .\" %ENDIF OS OS2 |
832b75ed | 142 | .PP |
a37e7145 GG |
143 | if \'\-\' is specified as the device path, \fBsmartctl\fP reads and |
144 | interprets it's own debug output from standard input. | |
145 | See \'\-r ataioctl\' below for details. | |
146 | .PP | |
832b75ed | 147 | Based on the device path, \fBsmartctl\fP will guess the device type |
ee38a438 | 148 | (ATA or SCSI). If necessary, the \'\-d\' option can be used to override |
832b75ed GG |
149 | this guess |
150 | ||
151 | Note that the printed output of \fBsmartctl\fP displays most numerical | |
152 | values in base 10 (decimal), but some values are displayed in base 16 | |
4d59bff9 | 153 | (hexadecimal). To distinguish them, the base 16 values are always |
832b75ed GG |
154 | displayed with a leading \fB"0x"\fP, for example: "0xff". This man |
155 | page follows the same convention. | |
156 | ||
832b75ed | 157 | .SH OPTIONS |
832b75ed GG |
158 | The options are grouped below into several categories. \fBsmartctl\fP |
159 | will execute the corresponding commands in the order: INFORMATION, | |
160 | ENABLE/DISABLE, DISPLAY DATA, RUN/ABORT TESTS. | |
161 | ||
832b75ed GG |
162 | .TP |
163 | .B SHOW INFORMATION OPTIONS: | |
164 | .TP | |
165 | .B \-h, \-\-help, \-\-usage | |
166 | Prints a usage message to STDOUT and exits. | |
167 | .TP | |
168 | .B \-V, \-\-version, \-\-copyright, \-\-license | |
2127e193 GI |
169 | Prints version, copyright, license, home page and SVN revision |
170 | information for your copy of \fBsmartctl\fP to STDOUT and then exits. | |
171 | Please include this information if you are reporting bugs or problems. | |
832b75ed GG |
172 | .TP |
173 | .B \-i, \-\-info | |
174 | Prints the device model number, serial number, firmware version, and | |
175 | ATA Standard version/revision information. Says if the device | |
176 | supports SMART, and if so, whether SMART support is currently enabled | |
177 | or disabled. If the device supports Logical Block Address mode (LBA | |
178 | mode) print current user drive capacity in bytes. (If drive is has a | |
179 | user protected area reserved, or is "clipped", this may be smaller | |
180 | than the potential maximum drive capacity.) Indicates if the drive is | |
181 | in the smartmontools database (see \'\-v\' options below). If so, the | |
4d59bff9 GG |
182 | drive model family may also be printed. If \'\-n\' (see below) is |
183 | specified, the power mode of the drive is printed. | |
832b75ed | 184 | .TP |
ee38a438 | 185 | .B \-\-identify[=[w][nvb]] |
d2e702cf | 186 | [ATA only] Prints an annotated table of the IDENTIFY DEVICE data. |
ee38a438 GI |
187 | By default, only valid words (words not equal to 0x0000 or 0xffff) |
188 | and nonzero bits and bit fields are printed. | |
189 | This can be changed by the optional argument which consists of one or | |
190 | two characters from the set \'wnvb\'. | |
191 | The character \'w\' enables printing of all 256 words. The character | |
192 | \'n\' suppresses printing of bits, \'v\' enables printing of all bits | |
193 | from valid words, \'b\' enables printing of all bits. | |
194 | For example \'\-\-identify=n\' (valid words, no bits) produces the | |
195 | shortest output and \'\-\-identify=wb\' (all words, all bits) produces | |
196 | the longest output. | |
197 | .TP | |
832b75ed GG |
198 | .B \-a, \-\-all |
199 | Prints all SMART information about the disk, or TapeAlert information | |
200 | about the tape drive or changer. For ATA devices this is equivalent | |
201 | to | |
202 | .nf | |
a37e7145 | 203 | \'\-H \-i \-c \-A \-l error \-l selftest \-l selective\' |
832b75ed GG |
204 | .fi |
205 | and for SCSI, this is equivalent to | |
206 | .nf | |
207 | \'\-H \-i \-A \-l error \-l selftest\'. | |
208 | .fi | |
2127e193 GI |
209 | Note that for ATA disks this does \fBnot\fP enable the non-SMART options |
210 | and the SMART options which require support for 48-bit ATA commands. | |
211 | .TP | |
212 | .B \-x, \-\-xall | |
213 | Prints all SMART and non-SMART information about the device. For ATA | |
214 | devices this is equivalent to | |
215 | .nf | |
d008864d | 216 | \'\-H \-i \-g all \-c \-A \-f brief \-l xerror,error \-l xselftest,selftest |
ee38a438 | 217 | \-l selective \-l directory \-l scttemp \-l scterc \-l devstat \-l sataphy\'. |
2127e193 GI |
218 | .fi |
219 | and for SCSI, this is equivalent to | |
220 | .nf | |
221 | \'\-H \-i \-A \-l error \-l selftest \-l background \-l sasphy\'. | |
222 | .fi | |
e9583e0c GI |
223 | .TP |
224 | .B \-\-scan | |
225 | Scans for devices and prints each device name, device type and protocol | |
226 | ([ATA] or [SCSI]) info. May be used in conjunction with \'\-d TYPE\' | |
227 | to restrict the scan to a specific TYPE. See also info about platform | |
228 | specific device scan and the \fBDEVICESCAN\fP directive on | |
229 | \fBsmartd\fP(8) man page. | |
230 | .TP | |
231 | .B \-\-scan\-open | |
232 | Same as \-\-scan, but also tries to open each device before printing | |
233 | device info. The device open may change the device type due | |
234 | to autodetection (see also \'\-d test\'). | |
832b75ed | 235 | |
cfbba5b9 GI |
236 | This option can be used to create a draft \fBsmartd.conf\fP file. |
237 | All options after \'\-\-\' are appended to each output line. | |
238 | For example: | |
239 | .nf | |
ee38a438 | 240 | smartctl \-\-scan\-open \-\- \-a \-W 4,45,50 \-m admin@work > smartd.conf |
cfbba5b9 | 241 | .fi |
d008864d GI |
242 | .TP |
243 | .B \-g NAME, \-\-get=NAME | |
ee38a438 | 244 | Get non-SMART device settings. See \'\-s, \-\-set\' below for further info. |
cfbba5b9 | 245 | |
832b75ed | 246 | .TP |
ee38a438 | 247 | .B RUN-TIME BEHAVIOR OPTIONS: |
832b75ed GG |
248 | .TP |
249 | .B \-q TYPE, \-\-quietmode=TYPE | |
250 | Specifies that \fBsmartctl\fP should run in one of the two quiet modes | |
251 | described here. The valid arguments to this option are: | |
252 | ||
253 | .I errorsonly | |
254 | \- only print: For the \'\-l error\' option, if nonzero, the number | |
ee38a438 | 255 | of errors recorded in the SMART error log and the power-on time when |
832b75ed | 256 | they occurred; For the \'\-l selftest\' option, errors recorded in the device |
ee38a438 GI |
257 | self-test log; For the \'\-H\' option, SMART "disk failing" status or device |
258 | Attributes (pre-failure or usage) which failed either now or in the | |
259 | past; For the \'\-A\' option, device Attributes (pre-failure or usage) | |
832b75ed GG |
260 | which failed either now or in the past. |
261 | ||
262 | .I silent | |
263 | \- print no output. The only way to learn about what was found is to | |
293b5ab8 | 264 | use the exit status of \fBsmartctl\fP (see EXIT STATUS below). |
a37e7145 GG |
265 | |
266 | .I noserial | |
267 | \- Do not print the serial number of the device. | |
832b75ed GG |
268 | .TP |
269 | .B \-d TYPE, \-\-device=TYPE | |
cfbba5b9 GI |
270 | Specifies the type of the device. |
271 | The valid arguments to this option are: | |
4d59bff9 | 272 | |
cfbba5b9 | 273 | .I auto |
ee38a438 | 274 | \- attempt to guess the device type from the device name or from |
cfbba5b9 GI |
275 | controller type info provided by the operating system or from |
276 | a matching USB ID entry in the drive database. | |
277 | This is the default. | |
278 | ||
279 | .I test | |
ee38a438 | 280 | \- prints the guessed type, then opens the device and prints the |
cfbba5b9 GI |
281 | (possibly changed) TYPE name and then exists without performing |
282 | any further commands. | |
283 | ||
284 | .I ata | |
285 | \- the device type is ATA. This prevents | |
286 | \fBsmartctl\fP | |
287 | from issuing SCSI commands to an ATA device. | |
288 | ||
d008864d | 289 | .\" %IF NOT OS Darwin |
cfbba5b9 GI |
290 | .I scsi |
291 | \- the device type is SCSI. This prevents | |
292 | \fBsmartctl\fP | |
293 | from issuing ATA commands to a SCSI device. | |
294 | ||
d008864d | 295 | .I sat[,auto][,N] |
cfbba5b9 GI |
296 | \- the device type is SCSI to ATA Translation (SAT). |
297 | This is for ATA disks that have a SCSI to ATA Translation (SAT) Layer | |
298 | (SATL) between the disk and the operating system. | |
4d59bff9 | 299 | SAT defines two ATA PASS THROUGH SCSI commands, one 12 bytes long and |
cfbba5b9 | 300 | the other 16 bytes long. The default is the 16 byte variant which can be |
4d59bff9 | 301 | overridden with either \'\-d sat,12\' or \'\-d sat,16\'. |
832b75ed | 302 | |
ee38a438 | 303 | If \'\-d sat,auto\' is specified, device type SAT (for ATA/SATA disks) is |
d008864d GI |
304 | only used if the SCSI INQUIRY data reports a SATL (VENDOR: "ATA "). |
305 | Otherwise device type SCSI (for SCSI/SAS disks) is used. | |
306 | ||
cfbba5b9 GI |
307 | .I usbcypress |
308 | \- this device type is for ATA disks that are behind a Cypress USB to PATA | |
309 | bridge. This will use the ATACB proprietary scsi pass through command. | |
310 | The default SCSI operation code is 0x24, but although it can be overridden | |
311 | with \'\-d usbcypress,0xN\', where N is the scsi operation code, | |
2127e193 GI |
312 | you're running the risk of damage to the device or filesystems on it. |
313 | ||
ee38a438 GI |
314 | .I usbjmicron[,p][,x][,PORT] |
315 | \- this device type is for SATA disks that are behind a JMicron USB to | |
cfbba5b9 GI |
316 | PATA/SATA bridge. The 48-bit ATA commands (required e.g. for \'\-l xerror\', |
317 | see below) do not work with all of these bridges and are therefore disabled by | |
318 | default. These commands can be enabled by \'\-d usbjmicron,x\'. | |
319 | If two disks are connected to a bridge with two ports, an error message is printed | |
320 | if no PORT is specified. | |
321 | The port can be specified by \'\-d usbjmicron[,x],PORT\' where PORT is 0 | |
322 | (master) or 1 (slave). This is not necessary if the device uses a port | |
323 | multiplier to connect multiple disks to one port. The disks appear under | |
324 | separate /dev/ice names then. | |
325 | CAUTION: Specifying \',x\' for a device which does not support it results | |
326 | in I/O errors and may disconnect the drive. The same applies if the specified | |
327 | PORT does not exist or is not connected to a disk. | |
328 | ||
ee38a438 GI |
329 | The Prolific PL2507/3507 USB bridges with older firmware support a pass-through |
330 | command similar to JMicron and work with \'\-d usbjmicron,0\'. | |
331 | Newer Prolific firmware requires a modified command which can be selected by | |
332 | \'\-d usbjmicron,p\'. | |
333 | Note that this does not yet support the SMART status command. | |
334 | ||
293b5ab8 JD |
335 | .I usbprolific |
336 | \- [NEW EXPERIMENTAL SMARTCTL FEATURE] | |
337 | this device type is for SATA disks that are behind a Prolific PL2571/2771/2773/2775 | |
338 | USB to SATA bridge. | |
339 | ||
cfbba5b9 GI |
340 | .I usbsunplus |
341 | \- this device type is for SATA disks that are behind a SunplusIT USB to SATA | |
342 | bridge. | |
343 | ||
d008864d GI |
344 | .\" %ENDIF NOT OS Darwin |
345 | .\" %IF OS Linux | |
cfbba5b9 GI |
346 | .I marvell |
347 | \- [Linux only] interact with SATA disks behind Marvell chip-set | |
348 | controllers (using the Marvell rather than libata driver). | |
349 | ||
350 | .I megaraid,N | |
351 | \- [Linux only] the device consists of one or more SCSI/SAS disks connected | |
352 | to a MegaRAID controller. The non-negative integer N (in the range of 0 to | |
353 | 127 inclusive) denotes which disk on the controller is monitored. | |
354 | Use syntax such as: | |
2127e193 GI |
355 | .nf |
356 | \fBsmartctl \-a \-d megaraid,2 /dev/sda\fP | |
357 | .fi | |
358 | .nf | |
359 | \fBsmartctl \-a \-d megaraid,0 /dev/sdb\fP | |
360 | .fi | |
ee38a438 GI |
361 | .nf |
362 | \fBsmartctl \-a \-d megaraid,0 /dev/bus/0\fP | |
363 | .fi | |
cfbba5b9 | 364 | This interface will also work for Dell PERC controllers. |
ee38a438 GI |
365 | It is possible to set RAID device name as /dev/bus/N, where N is a SCSI bus |
366 | number. | |
367 | ||
368 | The following entry in /proc/devices must exist: | |
d2e702cf | 369 | .br |
ee38a438 | 370 | For PERC2/3/4 controllers: \fBmegadevN\fP |
d2e702cf | 371 | .br |
ee38a438 | 372 | For PERC5/6 controllers: \fBmegaraid_sas_ioctlN\fP |
2127e193 | 373 | |
293b5ab8 JD |
374 | .\" %ENDIF OS Linux |
375 | .\" %IF OS Linux Windows Cygwin | |
d2e702cf | 376 | .I aacraid,H,L,ID |
293b5ab8 | 377 | \- [Linux, Windows and Cygwin only] [NEW EXPERIMENTAL SMARTCTL FEATURE] |
d2e702cf GI |
378 | the device consists of one or more SCSI/SAS disks connected to an AacRaid controller. |
379 | The non-negative integers H,L,ID (Host number, Lun, ID) denote which disk | |
380 | on the controller is monitored. | |
381 | Use syntax such as: | |
382 | .nf | |
293b5ab8 | 383 | \fBsmartctl \-a \-d aacraid,0,0,2 /dev/sda\fP |
d2e702cf GI |
384 | .fi |
385 | .nf | |
293b5ab8 | 386 | \fBsmartctl \-a \-d aacraid,1,0,4 /dev/sdb\fP |
d2e702cf | 387 | .fi |
d2e702cf | 388 | |
293b5ab8 JD |
389 | .\" %ENDIF OS Linux Windows Cygwin |
390 | .\" %IF OS Linux | |
391 | On Linux, the following entry in /proc/devices must exist: \fBaac\fP. | |
d2e702cf GI |
392 | Character device nodes /dev/aacH (H=Host number) are created if required. |
393 | ||
d008864d | 394 | .\" %ENDIF OS Linux |
293b5ab8 JD |
395 | .\" %IF OS Windows Cygwin |
396 | On Windows, the device name parameter /dev/sdX is ignored if \'-d aacraid\' | |
397 | is specified. | |
398 | ||
399 | .\" %ENDIF OS Windows Cygwin | |
d008864d | 400 | .\" %IF OS FreeBSD Linux |
cfbba5b9 GI |
401 | .I 3ware,N |
402 | \- [FreeBSD and Linux only] the device consists of one or more ATA disks | |
403 | connected to a 3ware RAID controller. The non-negative integer N | |
404 | (in the range from 0 to 127 inclusive) denotes which disk on the controller | |
405 | is monitored. | |
406 | Use syntax such as: | |
832b75ed | 407 | .nf |
ee38a438 | 408 | \fBsmartctl \-a \-d 3ware,2 /dev/sda\fP [Linux only] |
832b75ed GG |
409 | .fi |
410 | .nf | |
411 | \fBsmartctl \-a \-d 3ware,0 /dev/twe0\fP | |
412 | .fi | |
413 | .nf | |
414 | \fBsmartctl \-a \-d 3ware,1 /dev/twa0\fP | |
415 | .fi | |
cfbba5b9 | 416 | .nf |
ee38a438 GI |
417 | \fBsmartctl \-a \-d 3ware,1 /dev/twl0\fP [Linux only] |
418 | .fi | |
419 | .nf | |
420 | \fBsmartctl \-a \-d 3ware,1 /dev/tws0\fP [FreeBSD only] | |
cfbba5b9 GI |
421 | .fi |
422 | The first two forms, which refer to devices /dev/sda\-z and /dev/twe0\-15, | |
423 | may be used with 3ware series 6000, 7000, and 8000 series controllers | |
ee38a438 | 424 | that use the 3x-xxxx driver. |
cfbba5b9 GI |
425 | \fBNote that the /dev/sda\-z form is deprecated\fP starting with |
426 | the Linux 2.6 kernel series and may not be supported by the Linux | |
427 | kernel in the near future. The final form, which refers to devices | |
a37e7145 GG |
428 | /dev/twa0\-15, must be used with 3ware 9000 series controllers, which |
429 | use the 3w\-9xxx driver. | |
832b75ed | 430 | |
ee38a438 | 431 | The devices /dev/twl0\-15 [Linux] or /dev/tws0\-15 [FreeBSD] must be used with the 3ware/LSI 9750 series |
cfbba5b9 GI |
432 | controllers which use the 3w-sas driver. |
433 | ||
ee38a438 | 434 | Note that if the special character device nodes /dev/tw[ls]?, /dev/twa? |
cfbba5b9 | 435 | and /dev/twe? do not exist, or exist with the incorrect major or minor |
832b75ed | 436 | numbers, smartctl will recreate them on the fly. Typically /dev/twa0 |
ee38a438 | 437 | refers to the first 9000-series controller, /dev/twa1 refers to the |
cfbba5b9 GI |
438 | second 9000 series controller, and so on. The /dev/twl0 devices refers |
439 | to the first 9750 series controller, /dev/twl1 resfers to the second | |
440 | 9750 series controller, and so on. Likewise /dev/twe0 refers to | |
ee38a438 | 441 | the first 6/7/8000-series controller, /dev/twe1 refers to the second |
832b75ed GG |
442 | 6/7/8000 series controller, and so on. |
443 | ||
444 | Note that for the 6/7/8000 controllers, \fBany\fP of the physical | |
445 | disks can be queried or examined using \fBany\fP of the 3ware's SCSI | |
446 | logical device /dev/sd? entries. Thus, if logical device /dev/sda is | |
447 | made up of two physical disks (3ware ports zero and one) and logical | |
448 | device /dev/sdb is made up of two other physical disks (3ware ports | |
449 | two and three) then you can examine the SMART data on \fBany\fP of the | |
450 | four physical disks using \fBeither\fP SCSI device /dev/sda \fBor\fP | |
451 | /dev/sdb. If you need to know which logical SCSI device a particular | |
452 | physical disk (3ware port) is associated with, use the dmesg or SYSLOG | |
453 | output to show which SCSI ID corresponds to a particular 3ware unit, | |
454 | and then use the 3ware CLI or 3dm tool to determine which ports | |
455 | (physical disks) correspond to particular 3ware units. | |
456 | ||
457 | If the value of N corresponds to a port that does \fBnot\fP exist on | |
458 | the 3ware controller, or to a port that does not physically have a | |
459 | disk attached to it, the behavior of \fBsmartctl\fP depends upon the | |
460 | specific controller model, firmware, Linux kernel and platform. In | |
461 | some cases you will get a warning message that the device does not | |
cfbba5b9 | 462 | exist. In other cases you will be presented with \'void\' data for a |
ee38a438 | 463 | non-existent device. |
832b75ed | 464 | |
ee38a438 | 465 | Note that if the /dev/sd? addressing form is used, then older 3w-xxxx |
832b75ed GG |
466 | drivers do not pass the "Enable Autosave" |
467 | (\'\fB\-S on\fP\') and "Enable Automatic Offline" (\'\fB\-o on\fP\') | |
468 | commands to the disk, and produce these types of harmless syslog error | |
ee38a438 | 469 | messages instead: "\fB3w-xxxx: tw_ioctl(): Passthru size (123392) too |
cfbba5b9 | 470 | big\fP". This can be fixed by upgrading to version 1.02.00.037 or |
ee38a438 | 471 | later of the 3w-xxxx driver, or by applying a patch to older |
cfbba5b9 | 472 | versions. Alternatively, use the character device /dev/twe0\-15 interface. |
832b75ed | 473 | |
ee38a438 GI |
474 | The selective self-test functions (\'\-t select,A\-B\') are only supported |
475 | using the character device interface /dev/twl0\-15, /dev/tws0\-15, /dev/twa0\-15 and /dev/twe0\-15. | |
832b75ed GG |
476 | The necessary WRITE LOG commands can not be passed through the SCSI |
477 | interface. | |
478 | ||
d008864d | 479 | .\" %ENDIF OS FreeBSD Linux |
f4e463df | 480 | .\" %IF OS FreeBSD Linux Windows Cygwin |
cfbba5b9 | 481 | .I areca,N |
f4e463df GI |
482 | \- [FreeBSD, Linux, Windows and Cygwin only] the device consists of one or more SATA disks |
483 | connected to an Areca SATA RAID controller. The positive integer N (in the range | |
484 | from 1 to 24 inclusive) denotes which disk on the controller is monitored. | |
485 | .\" %ENDIF OS FreeBSD Linux Windows Cygwin | |
d008864d GI |
486 | .\" %IF OS Linux |
487 | On Linux use syntax such as: | |
2127e193 GI |
488 | .nf |
489 | \fBsmartctl \-a \-d areca,2 /dev/sg2\fP | |
490 | .fi | |
491 | .nf | |
492 | \fBsmartctl \-a \-d areca,3 /dev/sg3\fP | |
493 | .fi | |
d008864d GI |
494 | .\" %ENDIF OS Linux |
495 | .\" %IF OS FreeBSD | |
496 | On FreeBSD use syntax such as: | |
497 | .nf | |
498 | \fBsmartctl \-a \-d areca,2 /dev/arcmsr1\fP | |
499 | .fi | |
500 | .nf | |
501 | \fBsmartctl \-a \-d areca,3 /dev/arcmsr2\fP | |
502 | .fi | |
503 | .\" %ENDIF OS FreeBSD | |
f4e463df | 504 | .\" %IF OS Windows Cygwin |
293b5ab8 | 505 | On Windows and Cygwin use syntax such as: |
f4e463df GI |
506 | .nf |
507 | \fBsmartctl \-a \-d areca,2 /dev/arcmsr0\fP | |
508 | .fi | |
509 | .nf | |
510 | \fBsmartctl \-a \-d areca,3 /dev/arcmsr1\fP | |
511 | .fi | |
512 | .\" %ENDIF OS Windows Cygwin | |
513 | .\" %IF OS FreeBSD Linux Windows Cygwin | |
cfbba5b9 GI |
514 | The first line above addresses the second disk on the first Areca RAID controller. |
515 | The second line addresses the third disk on the second Areca RAID | |
d008864d | 516 | controller. |
f4e463df | 517 | .\" %ENDIF OS FreeBSD Linux Windows Cygwin |
d008864d | 518 | .\" %IF OS Linux |
f4e463df | 519 | To help identify the correct device on Linux, use the command: |
2127e193 GI |
520 | .nf |
521 | \fBcat /proc/scsi/sg/device_hdr /proc/scsi/sg/devices\fP | |
522 | .fi | |
523 | to show the SCSI generic devices (one per line, starting with | |
cfbba5b9 | 524 | /dev/sg0). The correct SCSI generic devices to address for |
2127e193 GI |
525 | smartmontools are the ones with the type field equal to 3. If the |
526 | incorrect device is addressed, please read the warning/error messages | |
527 | carefully. They should provide hints about what devices to use. | |
d008864d | 528 | .\" %ENDIF OS Linux |
f4e463df | 529 | .\" %IF OS FreeBSD Linux Windows Cygwin |
2127e193 GI |
530 | |
531 | Important: the Areca controller must have firmware version 1.46 or | |
cfbba5b9 | 532 | later. Lower-numbered firmware versions will give (harmless) SCSI |
2127e193 | 533 | error messages and no SMART information. |
4d59bff9 | 534 | |
f4e463df | 535 | .I areca,N/E |
293b5ab8 JD |
536 | \- [FreeBSD, Linux, Windows and Cygwin only] the device consists of one |
537 | or more SATA or SAS disks connected to an Areca SAS RAID controller. | |
f4e463df GI |
538 | The integer N (range 1 to 128) denotes the channel (slot) and E (range |
539 | 1 to 8) denotes the enclosure. | |
ee38a438 | 540 | Important: This requires Areca SAS controller firmware version 1.51 or later. |
f4e463df GI |
541 | |
542 | .\" %ENDIF OS FreeBSD Linux Windows Cygwin | |
d008864d | 543 | .\" %IF OS FreeBSD Linux |
cfbba5b9 | 544 | .I cciss,N |
ee38a438 | 545 | \- [FreeBSD and Linux only] the device consists of one or more SCSI/SAS or SATA disks |
cfbba5b9 GI |
546 | connected to a cciss RAID controller. The non-negative integer N (in the range |
547 | from 0 to 15 inclusive) denotes which disk on the controller is monitored. | |
548 | ||
ee38a438 GI |
549 | To look at disks behind HP Smart Array controllers, use syntax |
550 | such as: | |
551 | .\" %ENDIF OS FreeBSD Linux | |
552 | .\" %IF OS Linux | |
553 | .nf | |
554 | \fBsmartctl \-a \-d cciss,0 /dev/cciss/c0d0\fP (cciss driver under Linux) | |
555 | .fi | |
556 | .nf | |
557 | \fBsmartctl \-a \-d cciss,0 /dev/sg2\fP (hpsa or hpahcisr drivers under Linux) | |
558 | .fi | |
559 | .\" %ENDIF OS Linux | |
560 | .\" %IF OS FreeBSD | |
561 | .nf | |
562 | \fBsmartctl \-a \-d cciss,0 /dev/ciss0\fP (under FreeBSD) | |
563 | .fi | |
564 | .\" %ENDIF OS FreeBSD | |
565 | .\" %IF OS FreeBSD Linux | |
cfbba5b9 GI |
566 | |
567 | .I hpt,L/M/N | |
568 | \- [FreeBSD and Linux only] the device consists of one or more ATA disks | |
569 | connected to a HighPoint RocketRAID controller. The integer L is the | |
570 | controller id, the integer M is the channel number, and the integer N | |
571 | is the PMPort number if it is available. The allowed values of L are | |
3d17a85c | 572 | from 1 to 4 inclusive, M are from 1 to 128 inclusive and N from 1 to 4 |
cfbba5b9 GI |
573 | if PMPort available. And also these values are limited by the model |
574 | of the HighPoint RocketRAID controller. | |
575 | Use syntax such as: | |
d008864d GI |
576 | .\" %ENDIF OS FreeBSD Linux |
577 | .\" %IF OS Linux | |
4d59bff9 | 578 | .nf |
2127e193 GI |
579 | \fBsmartctl \-a \-d hpt,1/3 /dev/sda\fP (under Linux) |
580 | .fi | |
581 | .nf | |
582 | \fBsmartctl \-a \-d hpt,1/2/3 /dev/sda\fP (under Linux) | |
4d59bff9 | 583 | .fi |
d008864d GI |
584 | .\" %ENDIF OS Linux |
585 | .\" %IF OS FreeBSD | |
4d59bff9 | 586 | .nf |
2127e193 GI |
587 | \fBsmartctl \-a \-d hpt,1/3 /dev/hptrr\fP (under FreeBSD) |
588 | .fi | |
589 | .nf | |
590 | \fBsmartctl \-a \-d hpt,1/2/3 /dev/hptrr\fP (under FreeBSD) | |
4d59bff9 | 591 | .fi |
d008864d GI |
592 | .\" %ENDIF OS FreeBSD |
593 | .\" %IF OS FreeBSD Linux | |
a37e7145 | 594 | Note that the /dev/sda\-z form should be the device node which stands for |
2127e193 GI |
595 | the disks derived from the HighPoint RocketRAID controllers under Linux and |
596 | under FreeBSD, it is the character device which the driver registered (eg, | |
cfbba5b9 | 597 | /dev/hptrr, /dev/hptmv6). |
d008864d | 598 | .\" %ENDIF OS FreeBSD Linux |
832b75ed GG |
599 | .TP |
600 | .B \-T TYPE, \-\-tolerance=TYPE | |
2127e193 GI |
601 | [ATA only] Specifies how tolerant \fBsmartctl\fP should be of ATA and SMART |
602 | command failures. | |
832b75ed GG |
603 | |
604 | The behavior of \fBsmartctl\fP depends upon whether the command is | |
605 | "\fBoptional\fP" or "\fBmandatory\fP". Here "\fBmandatory\fP" means | |
ee38a438 | 606 | "required by the ATA Specification if the device implements |
832b75ed | 607 | the SMART command set" and "\fBoptional\fP" means "not required by the |
ee38a438 | 608 | ATA Specification even if the device implements the SMART |
832b75ed GG |
609 | command set." The "\fBmandatory\fP" ATA and SMART commands are: (1) |
610 | ATA IDENTIFY DEVICE, (2) SMART ENABLE/DISABLE ATTRIBUTE AUTOSAVE, (3) | |
611 | SMART ENABLE/DISABLE, and (4) SMART RETURN STATUS. | |
612 | ||
613 | The valid arguments to this option are: | |
614 | ||
615 | .I normal | |
616 | \- exit on failure of any \fBmandatory\fP SMART command, and ignore | |
617 | all failures of \fBoptional\fP SMART commands. This is the default. | |
618 | Note that on some devices, issuing unimplemented optional SMART | |
619 | commands doesn\'t cause an error. This can result in misleading | |
620 | \fBsmartctl\fP messages such as "Feature X not implemented", followed | |
621 | shortly by "Feature X: enabled". In most such cases, contrary to the | |
622 | final message, Feature X is \fBnot\fP enabled. | |
623 | ||
624 | .I conservative | |
625 | \- exit on failure of any \fBoptional\fP SMART command. | |
626 | ||
627 | .I permissive | |
628 | \- ignore failure(s) of \fBmandatory\fP SMART commands. This option | |
629 | may be given more than once. Each additional use of this option will | |
630 | cause one more additional failure to be ignored. Note that the use of | |
ee38a438 GI |
631 | this option can lead to messages like "Feature X not supported", |
632 | followed shortly by "Feature X enable failed". In a few | |
832b75ed GG |
633 | such cases, contrary to the final message, Feature X \fBis\fP enabled. |
634 | ||
635 | .I verypermissive | |
636 | \- equivalent to giving a large number of \'\-T permissive\' options: | |
637 | ignore failures of \fBany number\fP of \fBmandatory\fP SMART commands. | |
638 | Please see the note above. | |
832b75ed GG |
639 | .TP |
640 | .B \-b TYPE, \-\-badsum=TYPE | |
2127e193 GI |
641 | [ATA only] Specifies the action \fBsmartctl\fP should take if a checksum |
642 | error is detected in the: (1) Device Identity Structure, (2) SMART | |
ee38a438 | 643 | Self-Test Log Structure, (3) SMART Attribute Value Structure, (4) SMART |
832b75ed GG |
644 | Attribute Threshold Structure, or (5) ATA Error Log Structure. |
645 | ||
646 | The valid arguments to this option are: | |
647 | ||
648 | .I warn | |
649 | \- report the incorrect checksum but carry on in spite of it. This is the | |
650 | default. | |
651 | ||
652 | .I exit | |
653 | \- exit \fBsmartctl\fP. | |
654 | ||
655 | .I ignore | |
656 | \- continue silently without issuing a warning. | |
832b75ed GG |
657 | .TP |
658 | .B \-r TYPE, \-\-report=TYPE | |
659 | Intended primarily to help \fBsmartmontools\fP developers understand | |
ee38a438 | 660 | the behavior of \fBsmartmontools\fP on non-conforming or poorly |
832b75ed GG |
661 | conforming hardware. This option reports details of \fBsmartctl\fP |
662 | transactions with the device. The option can be used multiple times. | |
663 | When used just once, it shows a record of the ioctl() transactions | |
664 | with the device. When used more than once, the detail of these | |
665 | ioctl() transactions are reported in greater detail. The valid | |
666 | arguments to this option are: | |
667 | ||
668 | .I ioctl | |
669 | \- report all ioctl() transactions. | |
670 | ||
671 | .I ataioctl | |
672 | \- report only ioctl() transactions with ATA devices. | |
673 | ||
674 | .I scsiioctl | |
675 | \- report only ioctl() transactions with SCSI devices. Invoking this once | |
676 | shows the SCSI commands in hex and the corresponding status. Invoking | |
677 | it a second time adds a hex listing of the first 64 bytes of data send to, | |
678 | or received from the device. | |
679 | ||
680 | Any argument may include a positive integer to specify the level of detail | |
681 | that should be reported. The argument should be followed by a comma then | |
682 | the integer with no spaces. For example, | |
683 | .I ataioctl,2 | |
684 | The default | |
685 | level is 1, so \'\-r ataioctl,1\' and \'\-r ataioctl\' are equivalent. | |
686 | ||
a37e7145 GG |
687 | For testing purposes, the output of \'\-r ataioctl,2\' can later be parsed |
688 | by \fBsmartctl\fP itself if \'\-\' is used as device path argument. | |
689 | The ATA command input parameters, sector data and return values are | |
690 | reconstructed from the debug report read from stdin. | |
691 | Then \fBsmartctl\fP internally simulates an ATA device with the same | |
692 | behaviour. This is does not work for SCSI devices yet. | |
4d59bff9 GG |
693 | .TP |
694 | .B \-n POWERMODE, \-\-nocheck=POWERMODE | |
2127e193 | 695 | [ATA only] Specifies if \fBsmartctl\fP should exit before performing any |
ee38a438 GI |
696 | checks when the device is in a low-power mode. It may be used to prevent |
697 | a disk from being spun-up by \fBsmartctl\fP. The power mode is ignored by | |
cfbba5b9 | 698 | default. A nonzero exit status is returned if the device is in one of the |
293b5ab8 | 699 | specified low-power modes (see EXIT STATUS below). |
cfbba5b9 GI |
700 | |
701 | Note: If this option is used it may also be necessary to specify the device | |
ee38a438 | 702 | type with the \'\-d\' option. Otherwise the device may spin up due to |
cfbba5b9 GI |
703 | commands issued during device type autodetection. |
704 | ||
705 | The valid arguments to this option are: | |
4d59bff9 GG |
706 | |
707 | .I never | |
708 | \- check the device always, but print the power mode if \'\-i\' is | |
709 | specified. | |
710 | ||
711 | .I sleep | |
712 | \- check the device unless it is in SLEEP mode. | |
713 | ||
714 | .I standby | |
715 | \- check the device unless it is in SLEEP or STANDBY mode. In | |
716 | these modes most disks are not spinning, so if you want to prevent | |
717 | a disk from spinning up, this is probably what you want. | |
718 | ||
719 | .I idle | |
720 | \- check the device unless it is in SLEEP, STANDBY or IDLE mode. | |
721 | In the IDLE state, most disks are still spinning, so this is probably | |
722 | not what you want. | |
723 | ||
832b75ed GG |
724 | .TP |
725 | .B SMART FEATURE ENABLE/DISABLE COMMANDS: | |
726 | .IP | |
727 | .B Note: | |
728 | if multiple options are used to both enable and disable a | |
729 | feature, then | |
730 | .B both | |
731 | the enable and disable commands will be issued. The enable command | |
732 | will always be issued | |
733 | .B before | |
734 | the corresponding disable command. | |
735 | .TP | |
736 | .B \-s VALUE, \-\-smart=VALUE | |
737 | Enables or disables SMART on device. The valid arguments to | |
738 | this option are \fIon\fP and \fIoff\fP. Note that the command \'\-s on\' | |
2127e193 | 739 | (perhaps used with with the \'\-o on\' and \'\-S on\' options) should be |
ee38a438 | 740 | placed in a start-up script for your machine, for example in rc.local or |
2127e193 | 741 | rc.sysinit. In principle the SMART feature settings are preserved over |
ee38a438 | 742 | power-cycling, but it doesn\'t hurt to be sure. It is not necessary (or |
832b75ed GG |
743 | useful) to enable SMART to see the TapeAlert messages. |
744 | .TP | |
745 | .B \-o VALUE, \-\-offlineauto=VALUE | |
2127e193 GI |
746 | [ATA only] Enables or disables SMART automatic offline test, which scans the |
747 | drive every four hours for disk defects. This command can be given during | |
748 | normal system operation. The valid arguments to this option are \fIon\fP | |
832b75ed GG |
749 | and \fIoff\fP. |
750 | ||
751 | Note that the SMART automatic offline test command is listed as | |
752 | "Obsolete" in every version of the ATA and ATA/ATAPI Specifications. | |
ee38a438 | 753 | It was originally part of the SFF-8035i Revision 2.0 specification, |
832b75ed | 754 | but was never part of any ATA specification. However it is |
d2e702cf | 755 | implemented and used by many vendors. |
832b75ed GG |
756 | You can tell if automatic offline testing is supported by seeing if |
757 | this command enables and disables it, as indicated by the \'Auto | |
758 | Offline Data Collection\' part of the SMART capabilities report | |
759 | (displayed with \'\-c\'). | |
760 | ||
761 | SMART provides \fBthree\fP basic categories of testing. The | |
762 | \fBfirst\fP category, called "online" testing, has no effect on the | |
763 | performance of the device. It is turned on by the \'\-s on\' option. | |
764 | ||
765 | The \fBsecond\fP category of testing is called "offline" testing. This | |
766 | type of test can, in principle, degrade the device performance. The | |
767 | \'\-o on\' option causes this offline testing to be carried out, | |
768 | automatically, on a regular scheduled basis. Normally, the disk will | |
769 | suspend offline testing while disk accesses are taking place, and then | |
770 | automatically resume it when the disk would otherwise be idle, so in | |
ee38a438 | 771 | practice it has little effect. Note that a one-time offline test can |
832b75ed | 772 | also be carried out immediately upon receipt of a user command. See |
ee38a438 | 773 | the \'\-t offline\' option below, which causes a one-time offline test |
832b75ed GG |
774 | to be carried out immediately. |
775 | ||
ee38a438 | 776 | The choice (made by the SFF-8035i and ATA specification authors) of |
832b75ed GG |
777 | the word \fItesting\fP for these first two categories is unfortunate, |
778 | and often leads to confusion. In fact these first two categories of | |
779 | online and offline testing could have been more accurately described | |
780 | as online and offline \fBdata collection\fP. | |
781 | ||
782 | The results of this automatic or immediate offline testing (data | |
783 | collection) are reflected in the values of the SMART Attributes. | |
784 | Thus, if problems or errors are detected, the values of these | |
785 | Attributes will go below their failure thresholds; some types of | |
786 | errors may also appear in the SMART error log. These are visible with | |
787 | the \'\-A\' and \'\-l error\' options respectively. | |
788 | ||
ee38a438 | 789 | Some SMART attribute values are updated only during off-line data |
832b75ed | 790 | collection activities; the rest are updated during normal operation of |
ee38a438 | 791 | the device or during both normal operation and off-line testing. The |
832b75ed GG |
792 | Attribute value table produced by the \'\-A\' option indicates this in |
793 | the UPDATED column. Attributes of the first type are labeled | |
794 | "Offline" and Attributes of the second type are labeled "Always". | |
795 | ||
796 | The \fBthird\fP category of testing (and the \fIonly\fP category for | |
797 | which the word \'testing\' is really an appropriate choice) is "self" | |
798 | testing. This third type of test is only performed (immediately) when | |
799 | a command to run it is issued. The \'\-t\' and \'\-X\' options can be | |
ee38a438 | 800 | used to carry out and abort such self-tests; please see below for |
832b75ed GG |
801 | further details. |
802 | ||
803 | Any errors detected in the self testing will be shown in the | |
ee38a438 | 804 | SMART self-test log, which can be examined using the \'\-l selftest\' |
832b75ed GG |
805 | option. |
806 | ||
807 | \fBNote:\fP in this manual page, the word \fB"Test"\fP is used in | |
808 | connection with the second category just described, e.g. for the | |
ee38a438 | 809 | "offline" testing. The words \fB"Self-test"\fP are used in |
832b75ed GG |
810 | connection with the third category. |
811 | .TP | |
812 | .B \-S VALUE, \-\-saveauto=VALUE | |
ee38a438 | 813 | [ATA] Enables or disables SMART autosave of device vendor-specific |
832b75ed GG |
814 | Attributes. The valid arguments to this option are \fIon\fP |
815 | and \fIoff\fP. Note that this feature is preserved across disk power | |
816 | cycles, so you should only need to issue it once. | |
817 | ||
e9583e0c GI |
818 | The ATA standard does not specify a method to check whether SMART |
819 | autosave is enabled. Unlike SCSI (below), smartctl is unable to print | |
820 | a warning if autosave is disabled. | |
821 | ||
822 | [SCSI] For SCSI devices this toggles the value of the Global Logging | |
823 | Target Save Disabled (GLTSD) bit in the Control Mode Page. Some disk | |
832b75ed | 824 | manufacturers set this bit by default. This prevents error counters, |
ee38a438 | 825 | power-up hours and other useful data from being placed in non-volatile |
832b75ed | 826 | storage, so these values may be reset to zero the next time the device |
ee38a438 | 827 | is power-cycled. If the GLTSD bit is set then \'smartctl \-a\' will |
832b75ed | 828 | issue a warning. Use \fIon\fP to clear the GLTSD bit and thus enable |
ee38a438 | 829 | saving counters to non-volatile storage. For extreme streaming-video |
832b75ed GG |
830 | type applications you might consider using \fIoff\fP to set the GLTSD |
831 | bit. | |
d008864d GI |
832 | .TP |
833 | .B \-g NAME, \-\-get=NAME, \-s NAME[,VALUE], \-\-set=NAME[,VALUE] | |
ee38a438 | 834 | Gets/sets non-SMART device settings. |
d008864d GI |
835 | Note that the \'\-\-set\' option shares its short option \'\-s\' with |
836 | \'\-\-smart\'. Valid arguments are: | |
837 | ||
838 | .I all | |
839 | \- Gets all values. This is equivalent to | |
840 | .nf | |
841 | \'-g aam -g apm -g lookahead -g security -g wcache\' | |
842 | .fi | |
843 | ||
844 | .I aam[,N|off] | |
845 | \- [ATA only] Gets/sets the Automatic Acoustic Management (AAM) feature | |
846 | (if supported). A value of 128 sets the most quiet (slowest) mode and 254 | |
847 | the fastest (loudest) mode, \'off\' disables AAM. Devices may support | |
848 | intermediate levels. Values below 128 are defined as vendor specific (0) | |
ee38a438 | 849 | or retired (1 to 127). Note that the AAM feature was declared obsolete in |
d008864d GI |
850 | ATA ACS-2 Revision 4a (Dec 2010). |
851 | ||
852 | .I apm[,N|off] | |
853 | \- [ATA only] Gets/sets the Advanced Power Management (APM) feature on | |
854 | device (if supported). If a value between 1 and 254 is provided, it will | |
855 | attempt to enable APM and set the specified value, \'off\' disables APM. | |
856 | Note the actual behavior depends on the drive, for example some drives disable | |
857 | APM if their value is set above 128. Values below 128 are supposed to allow | |
858 | drive spindown, values 128 and above adjust only head-parking frequency, | |
859 | although the actual behavior defined is also vendor-specific. | |
860 | ||
861 | .I lookahead[,on|off] | |
862 | \- [ATA only] Gets/sets the read look-ahead feature (if supported). | |
863 | Read look-ahead is usually enabled by default. | |
864 | ||
865 | .I security | |
866 | \- [ATA only] Gets the status of ATA Security feature (if supported). | |
867 | If ATA Security is enabled an ATA user password is set. The drive will be | |
868 | locked on next reset then. | |
869 | ||
870 | .I security-freeze | |
871 | \- [ATA only] Sets ATA Security feature to frozen mode. This prevents that | |
872 | the drive accepts any security commands until next reset. Note that the | |
873 | frozen mode may already be set by BIOS or OS. | |
874 | ||
875 | .I standby,[N|off] | |
876 | \- [ATA only] Sets the standby (spindown) timer and places the drive in the | |
877 | IDLE mode. A value of 0 or \'off\' disables the standby timer. | |
878 | Values from 1 to 240 specify timeouts from 5 seconds to 20 minutes in 5 | |
879 | second increments. Values from 241 to 251 specify timeouts from 30 minutes | |
880 | to 330 minutes in 30 minute increments. Value 252 specifies 21 minutes. | |
881 | Value 253 specifies a vendor specific time between 8 and 12 hours. Value | |
882 | 255 specifies 21 minutes and 15 seconds. Some drives may use a vendor | |
883 | specific interpretation for the values. Note that there is no get option | |
884 | because ATA standards do not specify a method to read the standby timer. | |
885 | ||
886 | .I standby,now | |
887 | \- [ATA only] Places the drive in the STANDBY mode. This usually spins down | |
888 | the drive. The setting of the standby timer is not affected. | |
889 | ||
890 | .I wcache[,on|off] | |
ee38a438 | 891 | \- [ATA] Gets/sets the volatile write cache feature (if supported). |
d008864d | 892 | The write cache is usually enabled by default. |
832b75ed | 893 | |
ee38a438 | 894 | .I wcache[,on|off] |
293b5ab8 | 895 | \- [SCSI] Gets/sets the \'Write Cache Enable\' (WCE) bit (if supported). |
ee38a438 GI |
896 | The write cache is usually enabled by default. |
897 | ||
3d17a85c | 898 | .I wcreorder[,on|off] |
293b5ab8 | 899 | \- [ATA only] Gets/sets Write Cache Reordering. |
3d17a85c GI |
900 | If it is disabled (off), disk write scheduling is executed on a |
901 | first-in-first-out (FIFO) basis. If Write Cache Reordering is enabled (on), | |
902 | then disk write scheduling may be reordered by the drive. If write cache is | |
903 | disabled, the current Write Cache Reordering state is remembered but has | |
904 | no effect on non-cached writes, which are always written in the order received. | |
905 | The state of Write Cache Reordering has no effect on either NCQ or LCQ queued | |
906 | commands. | |
907 | ||
ee38a438 | 908 | .I rcache[,on|off] |
293b5ab8 JD |
909 | \- [SCSI only] Gets/sets the \'Read Cache Disable\' (RCE) bit. |
910 | \'Off\' value disables read cache (if supported). | |
ee38a438 GI |
911 | The read cache is usually enabled by default. |
912 | ||
832b75ed GG |
913 | .TP |
914 | .B SMART READ AND DISPLAY DATA OPTIONS: | |
915 | .TP | |
916 | .B \-H, \-\-health | |
293b5ab8 | 917 | Prints the health status of the device or pending TapeAlert messages. |
832b75ed GG |
918 | |
919 | If the device reports failing health status, this means | |
920 | .B either | |
921 | that the device has already failed, | |
922 | .B or | |
923 | that it is predicting its own failure within the next 24 hours. If | |
924 | this happens, use the \'\-a\' option to get more information, and | |
1953ff6d | 925 | .B get your data off the disk and to someplace safe as soon as you can. |
293b5ab8 JD |
926 | |
927 | [ATA] Health status is obtained by checking the (boolean) result returned | |
928 | by the SMART RETURN STATUS command. | |
929 | The return value of this ATA command may be unknown due to limitations or | |
930 | bugs in some layer (e.g. RAID controller or USB bridge firmware) between | |
931 | disk and operating system. | |
932 | In this case, \fBsmartctl\fP prints a warning and checks whether any | |
933 | Prefailure SMART Attribute value is less than or equal to its threshold | |
934 | (see \'\-A\' below). | |
935 | ||
936 | [SCSI] Health status is obtained by checking the Additional Sense Code | |
937 | (ASC) and Additional Sense Code Qualifier (ASCQ) from Informal Exceptions | |
938 | (IE) log page (if supported) and/or from SCSI sense data. | |
939 | ||
940 | [SCSI tape drive or changer] TapeAlert status is obtained by reading the | |
941 | TapeAlert log page. | |
942 | Please note that the TapeAlert log page flags are cleared for the initiator | |
943 | when the page is read. | |
944 | This means that each alert condition is reported only once by \fBsmartctl\fP | |
945 | for each initiator for each activation of the condition. | |
832b75ed GG |
946 | .TP |
947 | .B \-c, \-\-capabilities | |
2127e193 GI |
948 | [ATA only] Prints only the generic SMART capabilities. These |
949 | show what SMART features are implemented and how the device will | |
832b75ed GG |
950 | respond to some of the different SMART commands. For example it |
951 | shows if the device logs errors, if it supports offline surface | |
ee38a438 | 952 | scanning, and so on. If the device can carry out self-tests, this |
832b75ed GG |
953 | option also shows the estimated time required to run those tests. |
954 | ||
ee38a438 | 955 | Note that the time required to run the Self-tests (listed in minutes) |
832b75ed GG |
956 | are fixed. However the time required to run the Immediate Offline |
957 | Test (listed in seconds) is variable. This means that if you issue a | |
958 | command to perform an Immediate Offline test with the \'\-t offline\' option, | |
959 | then the time may jump to a larger value and then count down as the | |
960 | Immediate Offline Test is carried out. Please see REFERENCES below | |
961 | for further information about the the flags and capabilities described | |
962 | by this option. | |
963 | .TP | |
964 | .B \-A, \-\-attributes | |
2127e193 GI |
965 | [ATA] Prints only the vendor specific SMART Attributes. The Attributes |
966 | are numbered from 1 to 253 and have specific names and ID numbers. For | |
832b75ed GG |
967 | example Attribute 12 is "power cycle count": how many times has the |
968 | disk been powered up. | |
969 | ||
970 | Each Attribute has a "Raw" value, printed under the heading | |
971 | "RAW_VALUE", and a "Normalized" value printed under the heading | |
ee38a438 | 972 | "VALUE". [Note: \fBsmartctl\fP prints these values in base-10.] In |
832b75ed | 973 | the example just given, the "Raw Value" for Attribute 12 would be the |
ee38a438 | 974 | actual number of times that the disk has been power-cycled, for |
832b75ed GG |
975 | example 365 if the disk has been turned on once per day for exactly |
976 | one year. Each vendor uses their own algorithm to convert this "Raw" | |
977 | value to a "Normalized" value in the range from 1 to 254. Please keep | |
978 | in mind that \fBsmartctl\fP only reports the different Attribute | |
979 | types, values, and thresholds as read from the device. It does | |
980 | \fBnot\fP carry out the conversion between "Raw" and "Normalized" | |
981 | values: this is done by the disk\'s firmware. | |
982 | ||
983 | The conversion from Raw value to a quantity with physical units is | |
984 | not specified by the SMART standard. In most cases, the values printed | |
985 | by \fBsmartctl\fP are sensible. For example the temperature Attribute | |
986 | generally has its raw value equal to the temperature in Celsius. | |
987 | However in some cases vendors use unusual conventions. For example | |
ee38a438 | 988 | the Hitachi disk on my laptop reports its power-on hours in minutes, |
832b75ed GG |
989 | not hours. Some IBM disks track three temperatures rather than one, in |
990 | their raw values. And so on. | |
991 | ||
992 | Each Attribute also has a Threshold value (whose range is 0 to 255) | |
993 | which is printed under the heading "THRESH". If the Normalized value | |
994 | is \fBless than or equal to\fP the Threshold value, then the Attribute | |
ee38a438 | 995 | is said to have failed. If the Attribute is a pre-failure Attribute, |
832b75ed GG |
996 | then disk failure is imminent. |
997 | ||
998 | Each Attribute also has a "Worst" value shown under the heading | |
999 | "WORST". This is the smallest (closest to failure) value that the | |
1000 | disk has recorded at any time during its lifetime when SMART was | |
1001 | enabled. [Note however that some vendors firmware may actually | |
ee38a438 | 1002 | \fBincrease\fP the "Worst" value for some "rate-type" Attributes.] |
832b75ed GG |
1003 | |
1004 | The Attribute table printed out by \fBsmartctl\fP also shows the | |
1005 | "TYPE" of the Attribute. Attributes are one of two possible types: | |
ee38a438 | 1006 | Pre-failure or Old age. Pre-failure Attributes are ones which, if |
832b75ed GG |
1007 | less than or equal to their threshold values, indicate pending disk |
1008 | failure. Old age, or usage Attributes, are ones which indicate | |
ee38a438 | 1009 | end-of-product life from old-age or normal aging and wearout, if |
832b75ed | 1010 | the Attribute value is less than or equal to the threshold. \fBPlease |
ee38a438 | 1011 | note\fP: the fact that an Attribute is of type 'Pre-fail' does |
832b75ed GG |
1012 | \fBnot\fP mean that your disk is about to fail! It only has this |
1013 | meaning if the Attribute\'s current Normalized value is less than or | |
1014 | equal to the threshold value. | |
1015 | ||
1016 | If the Attribute\'s current Normalized value is less than or equal to | |
1017 | the threshold value, then the "WHEN_FAILED" column will display | |
1018 | "FAILING_NOW". If not, but the worst recorded value is less than or | |
1019 | equal to the threshold value, then this column will display | |
1020 | "In_the_past". If the "WHEN_FAILED" column has no entry (indicated by | |
1021 | a dash: \'\-\') then this Attribute is OK now (not failing) and has | |
1022 | also never failed in the past. | |
1023 | ||
1024 | The table column labeled "UPDATED" shows if the SMART Attribute values | |
ee38a438 | 1025 | are updated during both normal operation and off-line testing, or |
832b75ed GG |
1026 | only during offline testing. The former are labeled "Always" and the |
1027 | latter are labeled "Offline". | |
1028 | ||
1029 | So to summarize: the Raw Attribute values are the ones that might have | |
1030 | a real physical interpretation, such as "Temperature Celsius", | |
ee38a438 | 1031 | "Hours", or "Start-Stop Cycles". Each manufacturer converts these, |
832b75ed GG |
1032 | using their detailed knowledge of the disk\'s operations and failure |
1033 | modes, to Normalized Attribute values in the range 1\-254. The | |
1034 | current and worst (lowest measured) of these Normalized Attribute | |
1035 | values are stored on the disk, along with a Threshold value that the | |
1036 | manufacturer has determined will indicate that the disk is going to | |
1037 | fail, or that it has exceeded its design age or aging limit. | |
1038 | \fBsmartctl\fP does \fBnot\fP calculate any of the Attribute values, | |
1039 | thresholds, or types, it merely reports them from the SMART data on | |
1040 | the device. | |
1041 | ||
ee38a438 GI |
1042 | Note that starting with ATA/ATAPI-4, revision 4, the meaning of these |
1043 | Attribute fields has been made entirely vendor-specific. However most | |
1044 | newer ATA/SATA disks seem to respect their meaning, so we have retained | |
832b75ed GG |
1045 | the option of printing the Attribute values. |
1046 | ||
ee38a438 GI |
1047 | Solid-state drives use different meanings for some of the attributes. |
1048 | In this case the attribute name printed by smartctl is incorrect unless | |
1049 | the drive is already in the smartmontools drive database. | |
1050 | ||
2127e193 | 1051 | [SCSI] For SCSI devices the "attributes" are obtained from the temperature |
ee38a438 | 1052 | and start-stop cycle counter log pages. Certain vendor specific |
832b75ed GG |
1053 | attributes are listed if recognised. The attributes are output in a |
1054 | relatively free format (compared with ATA disk attributes). | |
1055 | .TP | |
a7e8ffec | 1056 | .B \-f FORMAT, \-\-format=FORMAT |
e165493d | 1057 | [ATA only] Selects the output format of the attributes: |
a7e8ffec GI |
1058 | |
1059 | .I old | |
1060 | \- Old smartctl format. This is the default unless the \'\-x\' option is | |
1061 | specified. | |
1062 | ||
1063 | .I brief | |
1064 | \- New format which fits into 80 colums (except in some rare cases). | |
1065 | This format also decodes four additional attribute flags. | |
1066 | This is the default if the '\-x\' option is specified. | |
e165493d GI |
1067 | |
1068 | .I hex,id | |
1069 | \- Print all attribute IDs as hexadecimal numbers. | |
1070 | ||
1071 | .I hex,val | |
1072 | \- Print all normalized values as hexadecimal numbers. | |
1073 | ||
1074 | .I hex | |
1075 | \- Same as \'\-f hex,id \-f hex,val\'. | |
a7e8ffec | 1076 | .TP |
832b75ed | 1077 | .B \-l TYPE, \-\-log=TYPE |
ee38a438 GI |
1078 | Prints either the SMART Error Log, the SMART Self-Test Log, the SMART |
1079 | Selective Self-Test Log [ATA only], the Log Directory [ATA only], or | |
4d59bff9 | 1080 | the Background Scan Results Log [SCSI only]. |
832b75ed GG |
1081 | The valid arguments to this option are: |
1082 | ||
1083 | .I error | |
2127e193 | 1084 | \- [ATA] prints the Summary SMART error log. SMART disks maintain a log |
ee38a438 GI |
1085 | of the most recent five non-trivial errors. For each of these errors, the |
1086 | disk power-on lifetime at which the error occurred is recorded, as is | |
832b75ed GG |
1087 | the device status (idle, standby, etc) at the time of the error. For |
1088 | some common types of errors, the Error Register (ER) and Status | |
1089 | Register (SR) values are decoded and printed as text. The meanings of these | |
1090 | are: | |
1091 | .nf | |
1092 | \fBABRT\fP: Command \fBAB\fPo\fBRT\fPed | |
1093 | \fBAMNF\fP: \fBA\fPddress \fBM\fPark \fBN\fPot \fBF\fPound | |
1094 | \fBCCTO\fP: \fBC\fPommand \fBC\fPompletion \fBT\fPimed \fBO\fPut | |
1095 | \fBEOM\fP: \fBE\fPnd \fBO\fPf \fBM\fPedia | |
1096 | \fBICRC\fP: \fBI\fPnterface \fBC\fPyclic \fBR\fPedundancy \fBC\fPode (CRC) error | |
1097 | \fBIDNF\fP: \fBID\fPentity \fBN\fPot \fBF\fPound | |
ee38a438 | 1098 | \fBILI\fP: (packet command-set specific) |
832b75ed GG |
1099 | \fBMC\fP: \fBM\fPedia \fBC\fPhanged |
1100 | \fBMCR\fP: \fBM\fPedia \fBC\fPhange \fBR\fPequest | |
1101 | \fBNM\fP: \fBN\fPo \fBM\fPedia | |
1102 | \fBobs\fP: \fBobs\fPolete | |
1103 | \fBTK0NF\fP: \fBT\fPrac\fBK 0 N\fPot \fBF\fPound | |
1104 | \fBUNC\fP: \fBUNC\fPorrectable Error in Data | |
1105 | \fBWP\fP: Media is \fBW\fPrite \fBP\fProtected | |
1106 | .fi | |
1107 | In addition, up to the last five commands that preceded the error are | |
1108 | listed, along with a timestamp measured from the start of the | |
1109 | corresponding power cycle. This is displayed in the form | |
1110 | Dd+HH:MM:SS.msec where D is the number of days, HH is hours, MM is | |
1111 | minutes, SS is seconds and msec is milliseconds. [Note: this time | |
1112 | stamp wraps after 2^32 milliseconds, or 49 days 17 hours 2 minutes and | |
1113 | 47.296 seconds.] The key ATA disk registers are also recorded in the | |
ee38a438 | 1114 | log. The final column of the error log is a text-string description |
832b75ed GG |
1115 | of the ATA command defined by the Command Register (CR) and Feature |
1116 | Register (FR) values. Commands that are obsolete in the most current | |
ee38a438 GI |
1117 | spec are listed like this: \fBREAD LONG (w/ retry) [OBS-4]\fP, |
1118 | indicating that the command became obsolete with or in the ATA-4 | |
832b75ed | 1119 | specification. Similarly, the notation \fB[RET\-\fP\fIN\fP\fB]\fP is |
ee38a438 | 1120 | used to indicate that a command was retired in the ATA-\fIN\fP |
832b75ed GG |
1121 | specification. Some commands are not defined in any version of the |
1122 | ATA specification but are in common use nonetheless; these are marked | |
ee38a438 | 1123 | \fB[NS]\fP, meaning non-standard. |
832b75ed | 1124 | |
d2e702cf GI |
1125 | The ATA Specification (ATA ACS-2 Revision 7, Section A.7.1) says: |
1126 | \fB"Error log data structures shall include, but are not limited to, | |
1127 | Uncorrectable errors, ID Not Found errors for which the LBA requested was | |
1128 | valid, servo errors, and write fault errors. Error log data structures | |
1129 | shall not include errors attributed to the receipt of faulty commands."\fP | |
1130 | The definitions of these terms are: | |
832b75ed GG |
1131 | .br |
1132 | \fBUNC\fP (\fBUNC\fPorrectable): data is uncorrectable. This refers | |
1133 | to data which has been read from the disk, but for which the Error | |
1134 | Checking and Correction (ECC) codes are inconsistent. In effect, this | |
1135 | means that the data can not be read. | |
1136 | .br | |
ee38a438 | 1137 | \fBIDNF\fP (\fBID N\fPot \fBF\fPound): user-accessible address could |
832b75ed GG |
1138 | not be found. For READ LOG type commands, \fBIDNF\fP can also indicate |
1139 | that a device data log structure checksum was incorrect. | |
1140 | ||
1141 | If the command that caused the error was a READ or WRITE command, then | |
1142 | the Logical Block Address (LBA) at which the error occurred will be | |
1143 | printed in base 10 and base 16. The LBA is a linear address, which | |
ee38a438 | 1144 | counts 512-byte sectors on the disk, starting from zero. (Because of |
832b75ed GG |
1145 | the limitations of the SMART error log, if the LBA is greater than |
1146 | 0xfffffff, then either no error log entry will be made, or the error | |
1147 | log entry will have an incorrect LBA. This may happen for drives with | |
1148 | a capacity greater than 128 GiB or 137 GB.) On Linux systems the | |
1149 | smartmontools web page has instructions about how to convert the LBA | |
1150 | address to the name of the disk file containing the erroneous disk | |
1151 | sector. | |
1152 | ||
1153 | Please note that some manufacturers \fBignore\fP the ATA | |
1154 | specifications, and make entries in the error log if the device | |
1155 | receives a command which is not implemented or is not valid. | |
1156 | ||
2127e193 GI |
1157 | .I error |
1158 | \- [SCSI] prints the error counter log pages for reads, write and verifies. | |
832b75ed GG |
1159 | The verify row is only output if it has an element other than zero. |
1160 | ||
2127e193 | 1161 | .I xerror[,NUM][,error] |
cfbba5b9 GI |
1162 | \- [ATA only] prints the Extended Comprehensive SMART error log |
1163 | (General Purpose Log address 0x03). Unlike the Summary SMART error | |
1164 | log (see \'\-l error\' above), it provides sufficient space to log | |
1165 | the contents of the 48-bit LBA register set introduced with ATA-6. | |
1166 | It also supports logs with more than one sector. Each sector holds | |
1167 | up to 4 log entries. The actual number of log sectors is vendor | |
d2e702cf | 1168 | specific. |
2127e193 GI |
1169 | |
1170 | Only the 8 most recent error log entries are printed by default. | |
1171 | This number can be changed by the optional parameter NUM. | |
1172 | ||
1173 | If ',error' is appended and the Extended Comprehensive SMART error | |
1174 | log is not supported, the Summary SMART self-test log is printed. | |
1175 | ||
f4e463df GI |
1176 | Please note that recent drives may report errors only in the Extended |
1177 | Comprehensive SMART error log. The Summary SMART error log may be reported | |
1178 | as supported but is always empty then. | |
2127e193 | 1179 | |
832b75ed | 1180 | .I selftest |
ee38a438 | 1181 | \- [ATA] prints the SMART self-test log. The disk maintains a self-test |
2127e193 | 1182 | log showing the results of the self tests, which can be run using the |
832b75ed | 1183 | \'\-t\' option described below. For each of the most recent |
ee38a438 GI |
1184 | twenty-one self-tests, the log shows the type of test (short or |
1185 | extended, off-line or captive) and the final status of the test. If | |
832b75ed GG |
1186 | the test did not complete successfully, then the percentage of the |
1187 | test remaining is shown. The time at which the test took place, | |
eb07ddf2 GI |
1188 | measured in hours of disk lifetime, is also printed. [Note: this time |
1189 | stamp wraps after 2^16 hours, or 2730 days and 16 hours, or about 7.5 | |
1190 | years.] If any errors were detected, the Logical Block Address (LBA) | |
1191 | of the first error is printed in decimal notation. On Linux systems the | |
1192 | smartmontools web page has instructions about how to convert this LBA | |
1193 | address to the name of the disk file containing the erroneous block. | |
832b75ed | 1194 | |
2127e193 | 1195 | .I selftest |
ee38a438 | 1196 | \- [SCSI] the self-test log for a SCSI device has a slightly different |
2127e193 | 1197 | format than for an ATA device. For each of the most recent twenty |
ee38a438 | 1198 | self-tests, it shows the type of test and the status (final or in |
832b75ed GG |
1199 | progress) of the test. SCSI standards use the terms "foreground" and |
1200 | "background" (rather than ATA\'s corresponding "captive" and | |
ee38a438 | 1201 | "off-line") and "short" and "long" (rather than ATA\'s corresponding |
832b75ed GG |
1202 | "short" and "extended") to describe the type of the test. The printed |
1203 | segment number is only relevant when a test fails in the third or | |
1204 | later test segment. It identifies the test that failed and consists | |
1205 | of either the number of the segment that failed during the test, or | |
1206 | the number of the test that failed and the number of the segment in | |
ee38a438 | 1207 | which the test was run, using a vendor-specific method of putting both |
832b75ed GG |
1208 | numbers into a single byte. The Logical Block Address (LBA) of the |
1209 | first error is printed in hexadecimal notation. On Linux systems the | |
1210 | smartmontools web page has instructions about how to convert this LBA | |
1211 | address to the name of the disk file containing the erroneous block. | |
1212 | If provided, the SCSI Sense Key (SK), Additional Sense Code (ASC) and | |
1213 | Additional Sense Code Qualifier (ASQ) are also printed. The self tests | |
1214 | can be run using the \'\-t\' option described below (using the ATA | |
1215 | test terminology). | |
1216 | ||
2127e193 | 1217 | .I xselftest[,NUM][,selftest] |
ee38a438 GI |
1218 | \- [ATA only] prints the Extended SMART self-test log (General Purpose |
1219 | Log address 0x07). Unlike the SMART self-test log (see \'\-l selftest\' | |
cfbba5b9 GI |
1220 | above), it supports 48-bit LBA and logs with more than one sector. |
1221 | Each sector holds up to 19 log entries. The actual number of log sectors | |
d2e702cf | 1222 | is vendor specific. |
2127e193 GI |
1223 | |
1224 | Only the 25 most recent log entries are printed by default. This number | |
1225 | can be changed by the optional parameter NUM. | |
1226 | ||
1227 | If ',selftest' is appended and the Extended SMART self-test log is not | |
1228 | supported, the old SMART self-test log is printed. | |
1229 | ||
1230 | .I selective | |
1231 | \- [ATA only] Please see the \'\-t select\' option below for a | |
ee38a438 | 1232 | description of selective self-tests. The selective self-test log |
832b75ed GG |
1233 | shows the start/end Logical Block Addresses (LBA) of each of the five |
1234 | test spans, and their current test status. If the span is being | |
ee38a438 GI |
1235 | tested or the remainder of the disk is being read-scanned, the |
1236 | current 65536-sector block of LBAs being tested is also displayed. | |
1237 | The selective self-test log also shows if a read-scan of the | |
832b75ed | 1238 | remainder of the disk will be carried out after the selective |
ee38a438 GI |
1239 | self-test has completed (see \'\-t afterselect\' option) and the time |
1240 | delay before restarting this read-scan if it is interrupted (see | |
1241 | \'\-t pending\' option). | |
832b75ed | 1242 | |
2127e193 GI |
1243 | .I directory[,gs] |
1244 | \- [ATA only] if the device supports the General Purpose Logging feature | |
ee38a438 | 1245 | set (ATA-6 and above) then this prints the Log Directory (the log at |
832b75ed GG |
1246 | address 0). The Log Directory shows what logs are available and their |
1247 | length in sectors (512 bytes). The contents of the logs at address 1 | |
ee38a438 GI |
1248 | [Summary SMART error log] and at address 6 [SMART self-test log] may |
1249 | be printed using the previously-described | |
832b75ed GG |
1250 | .I error |
1251 | and | |
1252 | .I selftest | |
2127e193 GI |
1253 | arguments to this option. |
1254 | If your version of smartctl supports 48-bit ATA commands, both the | |
1255 | General Purpose Log (GPL) and SMART Log (SL) directories are printed in | |
1256 | one combined table. The output can be restricted to the GPL directory or | |
1257 | SL directory by \'\-l directory,q\' or \'\-l directory,s\' respectively. | |
1258 | ||
1259 | .I background | |
1260 | \- [SCSI only] the background scan results log outputs information derived | |
ee38a438 | 1261 | from Background Media Scans (BMS) done after power up and/or periodically |
2127e193 | 1262 | (e.g. every 24 hours) on recent SCSI disks. If supported, the BMS status |
4d59bff9 GG |
1263 | is output first, indicating whether a background scan is currently |
1264 | underway (and if so a progress percentage), the amount of time the disk | |
1265 | has been powered up and the number of scans already completed. Then there | |
1266 | is a header and a line for each background scan "event". These will | |
1267 | typically be either recovered or unrecoverable errors. That latter group | |
1268 | may need some attention. There is a description of the background scan | |
ee38a438 | 1269 | mechanism in section 4.18 of SBC-3 revision 6 (see www.t10.org ). |
4d59bff9 | 1270 | |
2127e193 GI |
1271 | .I scttemp, scttempsts, scttemphist |
1272 | \- [ATA only] prints the disk temperature information provided by the | |
1273 | SMART Command Transport (SCT) commands. | |
a37e7145 GG |
1274 | The option \'scttempsts\' prints current temperature and temperature |
1275 | ranges returned by the SCT Status command, \'scttemphist\' prints | |
1276 | temperature limits and the temperature history table returned by | |
1277 | the SCT Data Table command, and \'scttemp\' prints both. | |
1278 | The temperature values are preserved across power cycles. | |
d008864d GI |
1279 | The logging interval can be configured with the |
1280 | \'\-l scttempint,N[,p]\' option, see below. | |
ee38a438 GI |
1281 | The SCT commands were introduced in ATA8-ACS and were also |
1282 | supported by many ATA-7 disks. | |
d008864d GI |
1283 | |
1284 | .I scttempint,N[,p] | |
1285 | \- [ATA only] clears the SCT temperature history table and sets the | |
1286 | time interval for temperature logging to N minutes. | |
1287 | If \',p\' is specified, the setting is preserved across power cycles. | |
1288 | Otherwise, the setting is volatile and will be reverted to the last | |
1289 | non-volatile setting by the next hard reset. The default interval | |
1290 | is vendor specific, typical values are 1, 2, or 5 minutes. | |
a37e7145 | 1291 | |
7f0798ef | 1292 | .I scterc[,READTIME,WRITETIME] |
d008864d GI |
1293 | \- [ATA only] prints values and descriptions of the SCT Error Recovery |
1294 | Control settings. These are equivalent to TLER (as used by Western | |
d2e702cf | 1295 | Digital), CCTL (as used by Samsung and Hitachi/HGST) and ERC (as used by |
d008864d GI |
1296 | Seagate). READTIME and WRITETIME arguments (deciseconds) set the |
1297 | specified values. Values of 0 disable the feature, other values less | |
1298 | than 65 are probably not supported. For RAID configurations, this is | |
1299 | typically set to 70,70 deciseconds. | |
1300 | ||
1301 | .I devstat[,PAGE] | |
ee38a438 GI |
1302 | \- [ATA only] prints values and descriptions of the ATA Device Statistics |
1303 | log pages (General Purpose Log address 0x04). If no PAGE number is specified, | |
d008864d GI |
1304 | entries from all supported pages are printed. If PAGE 0 is specified, |
1305 | the list of supported pages is printed. Device Statistics was | |
d2e702cf | 1306 | introduced in ACS-2 and is only supported by some recent devices. |
7f0798ef | 1307 | |
2127e193 | 1308 | .I sataphy[,reset] |
cfbba5b9 GI |
1309 | \- [SATA only] prints values and descriptions of the SATA Phy Event |
1310 | Counters (General Purpose Log address 0x11). If \'\-l sataphy,reset\' | |
1311 | is specified, all counters are reset after reading the values. | |
ee38a438 GI |
1312 | This also works for SATA devices with Packet interface like CD/DVD |
1313 | drives. | |
2127e193 GI |
1314 | |
1315 | .I sasphy[,reset] | |
cfbba5b9 GI |
1316 | \- [SAS (SCSI) only] prints values and descriptions of the SAS (SSP) |
1317 | Protocol Specific log page (log page 0x18). If \'\-l sasphy,reset\' | |
1318 | is specified, all counters are reset after reading the values. | |
2127e193 GI |
1319 | |
1320 | .I gplog,ADDR[,FIRST[\-LAST|+SIZE]] | |
cfbba5b9 GI |
1321 | \- [ATA only] prints a hex dump of any log accessible via General |
1322 | Purpose Logging (GPL) feature. The log address ADDR is the hex address | |
1323 | listed in the log directory (see \'\-l directory\' above). | |
1324 | The range of log sectors (pages) can be specified by decimal values | |
1325 | FIRST\-LAST or FIRST+SIZE. FIRST defaults to 0, SIZE defaults to 1. | |
1326 | LAST can be set to \'max\' to specify the last page of the log. | |
2127e193 GI |
1327 | |
1328 | .I smartlog,ADDR[,FIRST[\-LAST|+SIZE]] | |
cfbba5b9 GI |
1329 | \- [ATA only] prints a hex dump of any log accessible via SMART Read |
1330 | Log command. See \'\-l gplog,...\' above for parameter syntax. | |
2127e193 GI |
1331 | |
1332 | For example, all these commands: | |
1333 | .nf | |
1334 | smartctl \-l gplog,0x80,10-15 /dev/sda | |
1335 | smartctl \-l gplog,0x80,10+6 /dev/sda | |
1336 | smartctl \-l smartlog,0x80,10-15 /dev/sda | |
1337 | .fi | |
1338 | print pages 10-15 of log 0x80 (first host vendor specific log). | |
1339 | ||
1340 | The hex dump format is compatible with the \'xxd \-r\' command. | |
1341 | This command: | |
1342 | .nf | |
1343 | smartctl \-l gplog,0x11 /dev/sda | grep ^0 | xxd -r >log.bin | |
1344 | .fi | |
1345 | writes a binary representation of the one sector log 0x11 | |
1346 | (SATA Phy Event Counters) to file log.bin. | |
d008864d GI |
1347 | |
1348 | .I ssd | |
1349 | \- [ATA] prints the Solid State Device Statistics log page. | |
1350 | This has the same effect as \'\-l devstat,7\', see above. | |
1351 | ||
1352 | .I ssd | |
1353 | \- [SCSI] prints the Solid State Media percentage used endurance | |
1354 | indicator. A value of 0 indicates as new condition while 100 | |
1355 | indicates the device is at the end of its lifetime as projected by the | |
1356 | manufacturer. The value may reach 255. | |
832b75ed | 1357 | .TP |
a23d5117 | 1358 | .B \-v ID,FORMAT[:BYTEORDER][,NAME], \-\-vendorattribute=ID,FORMAT[:BYTEORDER][,NAME] |
ee38a438 | 1359 | [ATA only] Sets a vendor-specific raw value print FORMAT, an optional |
a23d5117 | 1360 | BYTEORDER and an optional NAME for Attribute ID. |
bed94269 | 1361 | This option may be used multiple times. |
832b75ed | 1362 | |
bed94269 | 1363 | The Attribute ID can be in the range 1 to 255. If \'N\' is specified as |
a23d5117 GI |
1364 | ID, the settings for all Attributes are changed. |
1365 | ||
1366 | The optional BYTEORDER consists of 1 to 8 characters from the | |
1367 | set \'012345rvwz\'. The characters \'0\' to \'5\' select the byte 0 | |
ee38a438 | 1368 | to 5 from the 48-bit raw value, \'r\' selects the reserved byte of |
a23d5117 GI |
1369 | the attribute data block, \'v\' selects the normalized value, \'w\' |
1370 | selects the worst value and \'z\' inserts a zero byte. | |
ee38a438 GI |
1371 | The default BYTEORDER is \'543210\' for all 48-bit formats, \'r543210\' |
1372 | for the 54-bit formats, and \'543210wv\' for the 64-bit formats. | |
a23d5117 GI |
1373 | For example, \'\-v 5,raw48:012345\' prints the raw value of |
1374 | attribute 5 with big endian instead of little endian | |
1375 | byte ordering. | |
1376 | ||
d008864d GI |
1377 | The NAME is a string of letters, digits and underscore. Its length should |
1378 | not exceed 23 characters. The \'\-P showall\' option reports an error if | |
1379 | this is the case. | |
bed94269 GI |
1380 | |
1381 | .I \-v help | |
832b75ed GG |
1382 | \- Prints (to STDOUT) a list of all valid arguments to this option, |
1383 | then exits. | |
1384 | ||
bed94269 GI |
1385 | Valid arguments for FORMAT are: |
1386 | ||
1387 | .I raw8 | |
ee38a438 | 1388 | \- Print the Raw value as six 8-bit unsigned base-10 integers. |
bed94269 GI |
1389 | This may be useful for decoding the meaning of the Raw value. |
1390 | ||
1391 | .I raw16 | |
ee38a438 | 1392 | \- Print the Raw value as three 16-bit unsigned base-10 integers. |
bed94269 GI |
1393 | This may be useful for decoding the meaning of the Raw value. |
1394 | ||
1395 | .I raw48 | |
ee38a438 | 1396 | \- Print the Raw value as a 48-bit unsigned base-10 integer. |
bed94269 GI |
1397 | This is the default for most attributes. |
1398 | ||
1399 | .I hex48 | |
1400 | \- Print the Raw value as a 12 digit hexadecimal number. | |
1401 | This may be useful for decoding the meaning of the Raw value. | |
1402 | ||
e165493d | 1403 | .I raw56 |
ee38a438 GI |
1404 | \- Print the Raw value as a 54-bit unsigned base-10 integer. |
1405 | This includes the reserved byte which follows the 48-bit raw value. | |
e165493d GI |
1406 | |
1407 | .I hex56 | |
1408 | \- Print the Raw value as a 14 digit hexadecimal number. | |
ee38a438 | 1409 | This includes the reserved byte which follows the 48-bit raw value. |
e165493d | 1410 | |
bed94269 | 1411 | .I raw64 |
ee38a438 | 1412 | \- Print the Raw value as a 64-bit unsigned base-10 integer. |
bed94269 | 1413 | This includes two bytes from the normalized and worst attribute value. |
e165493d | 1414 | This raw format is used by some SSD devices with Indilinx controller. |
bed94269 GI |
1415 | |
1416 | .I hex64 | |
1417 | \- Print the Raw value as a 16 digit hexadecimal number. | |
1418 | This includes two bytes from the normalized and worst attribute value. | |
e165493d | 1419 | This raw format is used by some SSD devices with Indilinx controller. |
bed94269 GI |
1420 | |
1421 | .I min2hour | |
ee38a438 | 1422 | \- Raw Attribute is power-on time in minutes. Its raw value |
832b75ed GG |
1423 | will be displayed in the form "Xh+Ym". Here X is hours, and Y is |
1424 | minutes in the range 0\-59 inclusive. Y is always printed with two | |
1425 | digits, for example "06" or "31" or "00". | |
1426 | ||
bed94269 | 1427 | .I sec2hour |
ee38a438 | 1428 | \- Raw Attribute is power-on time in seconds. Its raw value |
832b75ed GG |
1429 | will be displayed in the form "Xh+Ym+Zs". Here X is hours, Y is |
1430 | minutes in the range 0\-59 inclusive, and Z is seconds in the range | |
1431 | 0\-59 inclusive. Y and Z are always printed with two digits, for | |
1432 | example "06" or "31" or "00". | |
1433 | ||
bed94269 | 1434 | .I halfmin2hour |
ee38a438 | 1435 | \- Raw Attribute is power-on time, measured in units of 30 |
832b75ed GG |
1436 | seconds. This format is used by some Samsung disks. Its raw value |
1437 | will be displayed in the form "Xh+Ym". Here X is hours, and Y is | |
1438 | minutes in the range 0\-59 inclusive. Y is always printed with two | |
1439 | digits, for example "06" or "31" or "00". | |
1440 | ||
cfbba5b9 | 1441 | .I msec24hour32 |
ee38a438 | 1442 | \- Raw Attribute is power-on time measured in 32-bit hours and 24-bit |
cfbba5b9 GI |
1443 | milliseconds since last hour update. It will be displayed in the form |
1444 | "Xh+Ym+Z.Ms". Here X is hours, Y is minutes, Z is seconds and M is | |
1445 | milliseconds. | |
1446 | ||
bed94269 GI |
1447 | .I tempminmax |
1448 | \- Raw Attribute is the disk temperature in Celsius. Info about | |
cfbba5b9 GI |
1449 | Min/Max temperature is printed if available. This is the default |
1450 | for Attributes 190 and 194. The recording interval (lifetime, | |
1451 | last power cycle, last soft reset) of the min/max values is device | |
1452 | specific. | |
832b75ed | 1453 | |
bed94269 GI |
1454 | .I temp10x |
1455 | \- Raw Attribute is ten times the disk temperature in Celsius. | |
832b75ed | 1456 | |
bed94269 | 1457 | .I raw16(raw16) |
ee38a438 GI |
1458 | \- Print the raw attribute as a 16-bit value and two optional |
1459 | 16-bit values if these words are nonzero. This is the default | |
bed94269 GI |
1460 | for Attributes 5 and 196. |
1461 | ||
1462 | .I raw16(avg16) | |
1463 | \- Raw attribute is spin-up time. It is printed as a 16-bit value | |
1464 | and an optional "Average" 16-bit value if the word is nonzero. | |
1465 | This is the default for Attribute 3. | |
1466 | ||
e165493d | 1467 | .I raw24(raw8) |
ee38a438 GI |
1468 | \- Print the raw attribute as a 24-bit value and three optional |
1469 | 8-bit values if these bytes are nonzero. This is the default | |
e165493d GI |
1470 | for Attribute 9. |
1471 | ||
bed94269 | 1472 | .I raw24/raw24 |
ee38a438 | 1473 | \- Raw Attribute contains two 24-bit values. The first is the |
832b75ed GG |
1474 | number of load cycles. The second is the number of unload cycles. |
1475 | The difference between these two values is the number of times that | |
1476 | the drive was unexpectedly powered off (also called an emergency | |
1477 | unload). As a rule of thumb, the mechanical stress created by one | |
1478 | emergency unload is equivalent to that created by one hundred normal | |
1479 | unloads. | |
1480 | ||
cfbba5b9 | 1481 | .I raw24/raw32 |
ee38a438 GI |
1482 | \- Raw attribute is an error rate which consists of a 24-bit error |
1483 | count and a 32-bit total count. | |
cfbba5b9 | 1484 | |
bed94269 GI |
1485 | The following old arguments to \'\-v\' are also still valid: |
1486 | ||
1487 | .I 9,minutes | |
1488 | \- same as: | |
1489 | .I 9,min2hour,Power_On_Minutes. | |
1490 | ||
1491 | .I 9,seconds | |
1492 | \- same as: | |
1493 | .I 9,sec2hour,Power_On_Seconds. | |
1494 | ||
1495 | .I 9,halfminutes | |
1496 | \- same as: | |
1497 | .I 9,halfmin2hour,Power_On_Half_Minutes. | |
1498 | ||
1499 | .I 9,temp | |
1500 | \- same as: | |
1501 | .I 9,tempminmax,Temperature_Celsius. | |
1502 | ||
1503 | .I 192,emergencyretractcyclect | |
1504 | \- same as: | |
1505 | .I 192,raw48,Emerg_Retract_Cycle_Ct | |
1506 | ||
1507 | .I 193,loadunload | |
1508 | \- same as: | |
1509 | .I 193,raw24/raw24. | |
1510 | ||
832b75ed | 1511 | .I 194,10xCelsius |
bed94269 GI |
1512 | \- same as: |
1513 | .I 194,temp10x,Temperature_Celsius_x10. | |
832b75ed GG |
1514 | |
1515 | .I 194,unknown | |
bed94269 GI |
1516 | \- same as: |
1517 | .I 194,raw48,Unknown_Attribute. | |
832b75ed | 1518 | |
2127e193 | 1519 | .I 197,increasing |
bed94269 GI |
1520 | \- same as: |
1521 | .I 197,raw48,Total_Pending_Sectors. | |
1522 | Also means that Attribute number 197 (Current Pending Sector Count) | |
1523 | is not reset if uncorrectable sectors are reallocated | |
1524 | (see \fBsmartd.conf\fP(5) man page). | |
2127e193 GI |
1525 | |
1526 | .I 198,increasing | |
bed94269 GI |
1527 | \- same as: |
1528 | .I 198,raw48,Total_Offl_Uncorrectabl. | |
1529 | Also means that Attribute number 198 (Offline Uncorrectable Sector Count) | |
1530 | is not reset if uncorrectable sectors are reallocated | |
1531 | (see \fBsmartd.conf\fP(5) man page). | |
2127e193 | 1532 | |
832b75ed | 1533 | .I 198,offlinescanuncsectorct |
bed94269 GI |
1534 | \- same as: |
1535 | .I 198,raw48,Offline_Scan_UNC_SectCt. | |
832b75ed GG |
1536 | |
1537 | .I 200,writeerrorcount | |
bed94269 GI |
1538 | \- same as: |
1539 | .I 200,raw48,Write_Error_Count. | |
832b75ed GG |
1540 | |
1541 | .I 201,detectedtacount | |
bed94269 GI |
1542 | \- same as: |
1543 | .I 201,raw48,Detected_TA_Count. | |
832b75ed GG |
1544 | |
1545 | .I 220,temp | |
bed94269 | 1546 | \- same as: |
ee38a438 | 1547 | .I 220,tempminmax,Temperature_Celsius. |
832b75ed GG |
1548 | .TP |
1549 | .B \-F TYPE, \-\-firmwarebug=TYPE | |
2127e193 | 1550 | [ATA only] Modifies the behavior of \fBsmartctl\fP to compensate for some |
ee38a438 GI |
1551 | known and understood device firmware or driver bug. This option may be used |
1552 | multiple times. The valid arguments are: | |
832b75ed GG |
1553 | |
1554 | .I none | |
1555 | \- Assume that the device firmware obeys the ATA specifications. This | |
1556 | is the default, unless the device has presets for \'\-F\' in the | |
d2e702cf | 1557 | drive database. Using this option on the command line will override any |
ee38a438 GI |
1558 | preset values. |
1559 | ||
1560 | .I nologdir | |
1561 | \- Suppresses read attempts of SMART or GP Log Directory. | |
1562 | Support for all standard logs is assumed without an actual check. | |
1563 | Some Intel SSDs may freeze if log address 0 is read. | |
832b75ed GG |
1564 | |
1565 | .I samsung | |
1566 | \- In some Samsung disks (example: model SV4012H Firmware Version: | |
ee38a438 GI |
1567 | RM100-08) some of the two- and four-byte quantities in the SMART data |
1568 | structures are byte-swapped (relative to the ATA specification). | |
832b75ed | 1569 | Enabling this option tells \fBsmartctl\fP to evaluate these quantities |
ee38a438 GI |
1570 | in byte-reversed order. Some signs that your disk needs this option |
1571 | are (1) no self-test log printed, even though you have run self-tests; | |
832b75ed GG |
1572 | (2) very large numbers of ATA errors reported in the ATA error log; |
1573 | (3) strange and impossible values for the ATA error log timestamps. | |
1574 | ||
1575 | .I samsung2 | |
e9583e0c GI |
1576 | \- In some Samsung disks the number of ATA errors reported is byte swapped. |
1577 | Enabling this option tells \fBsmartctl\fP to evaluate this quantity in | |
ee38a438 GI |
1578 | byte-reversed order. An indication that your Samsung disk needs this |
1579 | option is that the self-test log is printed correctly, but there are a | |
832b75ed GG |
1580 | very large number of errors in the SMART error log. This is because |
1581 | the error count is byte swapped. Thus a disk with five errors | |
1582 | (0x0005) will appear to have 20480 errors (0x5000). | |
1583 | ||
a37e7145 | 1584 | .I samsung3 |
ee38a438 GI |
1585 | \- Some Samsung disks (at least SP2514N with Firmware VF100-37) report |
1586 | a self-test still in progress with 0% remaining when the test was already | |
1587 | completed. Enabling this option modifies the output of the self-test | |
a37e7145 GG |
1588 | execution status (see options \'\-c\' or \'\-a\' above) accordingly. |
1589 | ||
ee38a438 GI |
1590 | .I xerrorlba |
1591 | \- Fixes LBA byte ordering in Extended Comprehensive SMART error log. | |
d2e702cf | 1592 | Some disks use little endian byte ordering instead of ATA register |
ee38a438 | 1593 | ordering to specifiy the LBA addresses in the log entries. |
832b75ed | 1594 | |
a37e7145 GG |
1595 | .I swapid |
1596 | \- Fixes byte swapped ATA identify strings (device name, serial number, | |
1597 | firmware version) returned by some buggy device drivers. | |
832b75ed GG |
1598 | .TP |
1599 | .B \-P TYPE, \-\-presets=TYPE | |
2127e193 GI |
1600 | [ATA only] Specifies whether \fBsmartctl\fP should use any preset options |
1601 | that are available for this drive. By default, if the drive is recognized | |
832b75ed GG |
1602 | in the \fBsmartmontools\fP database, then the presets are used. |
1603 | ||
832b75ed GG |
1604 | The argument |
1605 | .I show | |
1606 | will show any preset options for your drive and the argument | |
1607 | .I showall | |
1608 | will show all known drives in the \fBsmartmontools\fP database, along | |
1609 | with their preset options. If there are no presets for your drive and | |
1610 | you think there should be (for example, a \-v or \-F option is needed | |
1611 | to get \fBsmartctl\fP to display correct values) then please contact | |
1612 | the \fBsmartmontools\fP developers so that this information can be | |
1613 | added to the \fBsmartmontools\fP database. Contact information is at the | |
1614 | end of this man page. | |
1615 | ||
1616 | The valid arguments to this option are: | |
1617 | ||
1618 | .I use | |
1619 | \- if a drive is recognized, then use the stored presets for it. This | |
ee38a438 GI |
1620 | is the default. Note that presets will NOT override additional |
1621 | Attribute interpretation (\'\-v N,something\') command-line options or | |
1622 | explicit \'\-F\' command-line options.. | |
832b75ed GG |
1623 | |
1624 | .I ignore | |
1625 | \- do not use presets. | |
1626 | ||
1627 | .I show | |
1628 | \- show if the drive is recognized in the database, and if so, its | |
1629 | presets, then exit. | |
1630 | ||
1631 | .I showall | |
1632 | \- list all recognized drives, and the presets that are set for them, | |
d008864d GI |
1633 | then exit. This also checks the drive database regular expressions |
1634 | and settings for syntax errors. | |
832b75ed GG |
1635 | |
1636 | The \'\-P showall\' option takes up to two optional arguments to | |
1637 | match a specific drive type and firmware version. The command: | |
1638 | .nf | |
1639 | smartctl \-P showall | |
1640 | .fi | |
1641 | lists all entries, the command: | |
1642 | .nf | |
1643 | smartctl \-P showall \'MODEL\' | |
1644 | .fi | |
1645 | lists all entries matching MODEL, and the command: | |
1646 | .nf | |
1647 | smartctl \-P showall \'MODEL\' \'FIRMWARE\' | |
1648 | .fi | |
1649 | lists all entries for this MODEL and a specific FIRMWARE version. | |
2127e193 GI |
1650 | .TP |
1651 | .B \-B [+]FILE, \-\-drivedb=[+]FILE | |
cfbba5b9 GI |
1652 | [ATA only] Read the drive database from FILE. The new database replaces |
1653 | the built in database by default. If \'+\' is specified, then the new | |
1654 | entries prepend the built in entries. | |
2127e193 | 1655 | |
d008864d GI |
1656 | Optional entries are read from the file |
1657 | .\" %IF NOT OS Windows | |
1658 | \fB/usr/local/etc/smart_drivedb.h\fP | |
1659 | .\" %ENDIF NOT OS Windows | |
1660 | .\" %IF OS ALL | |
1661 | (Windows: \fBEXEDIR/drivedb-add.h\fP) | |
1662 | .\" %ENDIF OS ALL | |
1663 | .\" %IF OS Windows | |
1664 | .\"! \fBEXEDIR/drivedb-add.h\fP. | |
1665 | .\" %ENDIF OS Windows | |
1666 | .\" %IF ENABLE_DRIVEDB | |
1667 | if this option is not specified. | |
1668 | ||
1669 | If | |
1670 | .\" %IF NOT OS Windows | |
1671 | \fB/usr/local/share/smartmontools/drivedb.h\fP | |
1672 | .\" %ENDIF NOT OS Windows | |
1673 | .\" %IF OS ALL | |
1674 | (Windows: \fBEXEDIR/drivedb.h\fP) | |
1675 | .\" %ENDIF OS ALL | |
1676 | .\" %IF OS Windows | |
1677 | .\"! \fBEXEDIR/drivedb.h\fP | |
1678 | .\" %ENDIF OS Windows | |
1679 | is present, the contents of this file is used instead of the built in table. | |
1680 | ||
1681 | Run | |
1682 | .\" %IF NOT OS Windows | |
1683 | \fB/usr/local/sbin/update-smart-drivedb\fP | |
1684 | .\" %ENDIF NOT OS Windows | |
1685 | .\" %IF OS ALL | |
1686 | (Windows: \fBEXEDIR/update-smart-drivedb.exe\fP) | |
1687 | .\" %ENDIF OS ALL | |
1688 | .\" %IF OS Windows | |
1689 | .\"! \fBEXEDIR/update-smart-drivedb.exe\fP | |
1690 | .\" %ENDIF OS Windows | |
1691 | to update this file from the smartmontools SVN repository. | |
1692 | .\" %ENDIF ENABLE_DRIVEDB | |
2127e193 GI |
1693 | |
1694 | The database files use the same C/C++ syntax that is used to initialize | |
1695 | the built in database array. C/C++ style comments are allowed. | |
1696 | Example: | |
1697 | ||
1698 | .nf | |
1699 | /* Full entry: */ | |
1700 | { | |
1701 | "Model family", // Info about model family/series. | |
1702 | "MODEL1.*REGEX", // Regular expression to match model of device. | |
1703 | "VERSION.*REGEX", // Regular expression to match firmware version(s). | |
1704 | "Some warning", // Warning message. | |
1705 | "\-v 9,minutes" // String of preset \-v and \-F options. | |
1706 | }, | |
1707 | /* Minimal entry: */ | |
1708 | { | |
1709 | "", // No model family/series info. | |
1710 | "MODEL2.*REGEX", // Regular expression to match model of device. | |
1711 | "", // All firmware versions. | |
1712 | "", // No warning. | |
1713 | "" // No options preset. | |
1714 | }, | |
e9583e0c GI |
1715 | /* USB ID entry: */ |
1716 | { | |
1717 | "USB: Device; Bridge", // Info about USB device and bridge name. | |
1718 | "0x1234:0xabcd", // Regular expression to match vendor:product ID. | |
1719 | "0x0101", // Regular expression to match bcdDevice. | |
1720 | "", // Not used. | |
1721 | "\-d sat" // String with device type option. | |
1722 | }, | |
2127e193 GI |
1723 | /* ... */ |
1724 | .fi | |
1725 | ||
832b75ed | 1726 | .TP |
ee38a438 | 1727 | .B SMART RUN/ABORT OFFLINE TEST AND self-test OPTIONS: |
832b75ed GG |
1728 | .TP |
1729 | .B \-t TEST, \-\-test=TEST | |
1730 | Executes TEST immediately. The \'\-C\' option can be used in | |
1731 | conjunction with this option to run the short or long (and also for | |
ee38a438 | 1732 | ATA devices, selective or conveyance) self-tests in captive mode |
832b75ed GG |
1733 | (known as "foreground mode" for SCSI devices). Note that only one |
1734 | test type can be run at a time, so only one test type should be | |
1735 | specified per command line. Note also that if a computer is shutdown | |
ee38a438 GI |
1736 | or power cycled during a self-test, no harm should result. The |
1737 | self-test will either be aborted or will resume automatically. | |
1738 | ||
1739 | All \'\-t TEST\' commands can be given during normal system operation | |
1740 | unless captive mode (\'\-C\' option) is used. | |
1741 | A running self-test can, however, degrade performance of the drive. | |
1742 | Frequent I/O requests from the operating system increase the duration | |
1743 | of a test. These impacts may vary from device to device. | |
832b75ed | 1744 | |
ee38a438 GI |
1745 | If a test failure occurs then the device may discontinue the testing |
1746 | and report the result immediately. | |
1747 | ||
1748 | The valid arguments to this option are: | |
832b75ed GG |
1749 | |
1750 | .I offline | |
e9583e0c | 1751 | \- [ATA] runs SMART Immediate Offline Test. This immediately |
832b75ed GG |
1752 | starts the test described above. This command can be given during |
1753 | normal system operation. The effects of this test are visible only in | |
1754 | that it updates the SMART Attribute values, and if errors are | |
1755 | found they will appear in the SMART error log, visible with the \'\-l error\' | |
e9583e0c | 1756 | option. |
832b75ed GG |
1757 | |
1758 | If the \'\-c\' option to \fBsmartctl\fP shows that the device has the | |
1759 | "Suspend Offline collection upon new command" capability then you can | |
1760 | track the progress of the Immediate Offline test using the \'\-c\' | |
1761 | option to \fBsmartctl\fP. If the \'\-c\' option show that the device | |
1762 | has the "Abort Offline collection upon new command" capability then | |
1763 | most commands will abort the Immediate Offline Test, so you should not | |
1764 | try to track the progress of the test with \'\-c\', as it will abort | |
1765 | the test. | |
1766 | ||
e9583e0c GI |
1767 | .I offline |
1768 | \- [SCSI] runs the default self test in foreground. No entry is placed | |
1769 | in the self test log. | |
1770 | ||
832b75ed | 1771 | .I short |
e9583e0c | 1772 | \- [ATA] runs SMART Short Self Test (usually under ten minutes). |
832b75ed GG |
1773 | This command can be given during normal system operation (unless run in |
1774 | captive mode \- see the \'\-C\' option below). This is a | |
1775 | test in a different category than the immediate or automatic offline | |
1776 | tests. The "Self" tests check the electrical and mechanical | |
1777 | performance as well as the read performance of the disk. Their | |
1778 | results are reported in the Self Test Error Log, readable with | |
1779 | the \'\-l selftest\' option. Note that on some disks the progress of the | |
ee38a438 | 1780 | self-test can be monitored by watching this log during the self-test; with other disks |
832b75ed GG |
1781 | use the \'\-c\' option to monitor progress. |
1782 | ||
e9583e0c | 1783 | .I short |
ee38a438 | 1784 | \- [SCSI] runs the "Background short" self-test. |
e9583e0c | 1785 | |
832b75ed | 1786 | .I long |
e9583e0c | 1787 | \- [ATA] runs SMART Extended Self Test (tens of minutes). This is a |
832b75ed GG |
1788 | longer and more thorough version of the Short Self Test described |
1789 | above. Note that this command can be given during normal | |
1790 | system operation (unless run in captive mode \- see the \'\-C\' option below). | |
1791 | ||
e9583e0c | 1792 | .I long |
ee38a438 | 1793 | \- [SCSI] runs the "Background long" self-test. |
e9583e0c | 1794 | |
832b75ed | 1795 | .I conveyance |
2127e193 | 1796 | \- [ATA only] runs a SMART Conveyance Self Test (minutes). This |
ee38a438 GI |
1797 | self-test routine is intended to identify damage incurred during |
1798 | transporting of the device. This self-test routine should take on the | |
832b75ed GG |
1799 | order of minutes to complete. Note that this command can be given |
1800 | during normal system operation (unless run in captive mode \- see the | |
1801 | \'\-C\' option below). | |
1802 | ||
a37e7145 | 1803 | .I select,N\-M, select,N+SIZE |
2127e193 GI |
1804 | \- [ATA only] runs a SMART Selective Self Test, to test a \fBrange\fP |
1805 | of disk Logical Block Addresses (LBAs), rather than the entire disk. | |
1806 | Each range of LBAs that is checked is called a "span" and is specified | |
1807 | by a starting LBA (N) and an ending LBA (M) with N less than or equal | |
1808 | to M. The range can also be specified as N+SIZE. A span at the end of | |
1809 | a disk can be specified by N\-\fBmax\fP. | |
a37e7145 GG |
1810 | |
1811 | For example the commands: | |
832b75ed | 1812 | .nf |
293b5ab8 JD |
1813 | smartctl \-t select,10\-20 /dev/sda |
1814 | smartctl \-t select,10+11 /dev/sda | |
832b75ed | 1815 | .fi |
a37e7145 GG |
1816 | both runs a self test on one span consisting of LBAs ten to twenty |
1817 | (inclusive). The command: | |
1818 | .nf | |
293b5ab8 | 1819 | smartctl \-t select,100000000\-max /dev/sda |
a37e7145 GG |
1820 | .fi |
1821 | run a self test from LBA 100000000 up to the end of the disk. | |
1822 | The \'\-t\' option can be given up to five times, to test | |
832b75ed GG |
1823 | up to five spans. For example the command: |
1824 | .nf | |
293b5ab8 | 1825 | smartctl \-t select,0\-100 \-t select,1000\-2000 /dev/sda |
832b75ed GG |
1826 | .fi |
1827 | runs a self test on two spans. The first span consists of 101 LBAs | |
1828 | and the second span consists of 1001 LBAs. Note that the spans can | |
1829 | overlap partially or completely, for example: | |
1830 | .nf | |
293b5ab8 | 1831 | smartctl \-t select,0\-10 \-t select,5\-15 \-t select,10\-20 /dev/sda |
832b75ed | 1832 | .fi |
ee38a438 GI |
1833 | The results of the selective self-test can be obtained (both during |
1834 | and after the test) by printing the SMART self-test log, using the | |
832b75ed GG |
1835 | \'\-l selftest\' option to smartctl. |
1836 | ||
1837 | Selective self tests are particularly useful as disk capacities | |
1838 | increase: an extended self test (smartctl \-t long) can take several | |
ee38a438 GI |
1839 | hours. Selective self-tests are helpful if (based on SYSLOG error |
1840 | messages, previous failed self-tests, or SMART error log entries) you | |
832b75ed GG |
1841 | suspect that a disk is having problems at a particular range of |
1842 | Logical Block Addresses (LBAs). | |
1843 | ||
ee38a438 | 1844 | Selective self-tests can be run during normal system operation (unless |
832b75ed GG |
1845 | done in captive mode \- see the \'\-C\' option below). |
1846 | ||
ee38a438 | 1847 | The following variants of the selective self-test command use spans based |
a37e7145 GG |
1848 | on the ranges from past tests already stored on the disk: |
1849 | ||
1850 | .I select,redo[+SIZE] | |
2127e193 GI |
1851 | \- [ATA only] redo the last SMART Selective Self Test using the same LBA |
1852 | range. The starting LBA is identical to the LBA used by last test, same | |
1853 | for ending LBA unless a new span size is specified by optional +SIZE | |
1854 | argument. | |
a37e7145 GG |
1855 | |
1856 | For example the commands: | |
1857 | .nf | |
293b5ab8 JD |
1858 | smartctl \-t select,10\-20 /dev/sda |
1859 | smartctl \-t select,redo /dev/sda | |
1860 | smartctl \-t select,redo+20 /dev/sda | |
a37e7145 GG |
1861 | .fi |
1862 | have the same effect as: | |
1863 | .nf | |
293b5ab8 JD |
1864 | smartctl \-t select,10\-20 /dev/sda |
1865 | smartctl \-t select,10\-20 /dev/sda | |
1866 | smartctl \-t select,10\-29 /dev/sda | |
a37e7145 GG |
1867 | .fi |
1868 | ||
1869 | .I select,next[+SIZE] | |
2127e193 GI |
1870 | \- [ATA only] runs a SMART Selective Self Test on the LBA range which |
1871 | follows the range of the last test. The starting LBA is set to (ending | |
1872 | LBA +1) of the last test. A new span size may be specified by the | |
1873 | optional +SIZE argument. | |
a37e7145 GG |
1874 | |
1875 | For example the commands: | |
1876 | .nf | |
293b5ab8 JD |
1877 | smartctl \-t select,0\-999 /dev/sda |
1878 | smartctl \-t select,next /dev/sda | |
1879 | smartctl \-t select,next+2000 /dev/sda | |
a37e7145 GG |
1880 | .fi |
1881 | have the same effect as: | |
1882 | .nf | |
293b5ab8 JD |
1883 | smartctl \-t select,0\-999 /dev/sda |
1884 | smartctl \-t select,1000\-1999 /dev/sda | |
1885 | smartctl \-t select,2000\-3999 /dev/sda | |
a37e7145 GG |
1886 | .fi |
1887 | ||
1888 | If the last test ended at the last LBA of the disk, the new range starts | |
1889 | at LBA 0. The span size of the last span of a disk is adjusted such that | |
1890 | the total number of spans to check the full disk will not be changed | |
1891 | by future uses of \'\-t select,next\'. | |
1892 | ||
1893 | .I select,cont[+SIZE] | |
2127e193 GI |
1894 | \- [ATA only] performs a \'redo\' (above) if the self test status reports |
1895 | that the last test was aborted by the host. Otherwise it run the \'next\' | |
1896 | (above) test. | |
832b75ed GG |
1897 | |
1898 | .I afterselect,on | |
ee38a438 | 1899 | \- [ATA only] perform an offline read scan after a Selective self-test |
832b75ed GG |
1900 | has completed. This option must be used together with one or more of |
1901 | the \fIselect,N\-M\fP options above. If the LBAs that have been | |
ee38a438 | 1902 | specified in the Selective self-test pass the test with no errors |
832b75ed | 1903 | found, then read scan the \fBremainder\fP of the disk. If the device |
ee38a438 | 1904 | is powered-cycled while this read scan is in progress, the read scan |
832b75ed GG |
1905 | will be automatically resumed after a time specified by the pending |
1906 | timer (see below). The value of this option is preserved between | |
ee38a438 | 1907 | selective self-tests. |
832b75ed GG |
1908 | |
1909 | .I afterselect,off | |
2127e193 | 1910 | \- [ATA only] do not read scan the remainder of the disk after a |
ee38a438 | 1911 | Selective self-test has completed. This option must be use together |
832b75ed | 1912 | with one or more of the \fIselect,N\-M\fP options above. The value of this |
ee38a438 | 1913 | option is preserved between selective self-tests. |
832b75ed GG |
1914 | |
1915 | .I pending,N | |
2127e193 | 1916 | \- [ATA only] set the pending offline read scan timer to N minutes. |
832b75ed | 1917 | Here N is an integer in the range from 0 to 65535 inclusive. If the |
ee38a438 GI |
1918 | device is powered off during a read scan after a Selective self-test, |
1919 | then resume the test automatically N minutes after power-up. This | |
832b75ed GG |
1920 | option must be use together with one or more of the \fIselect,N\-M\fP |
1921 | options above. The value of this option is preserved between selective | |
ee38a438 | 1922 | self-tests. |
832b75ed | 1923 | |
cfbba5b9 GI |
1924 | .I vendor,N |
1925 | \- [ATA only] issues the ATA command SMART EXECUTE OFF-LINE IMMEDIATE | |
1926 | with subcommand N in LBA LOW register. The subcommand is specified as | |
a7e8ffec | 1927 | a hex value in the range 0x00 to 0xff. Subcommands 0x40-0x7e and |
cfbba5b9 | 1928 | 0x90-0xff are reserved for vendor specific use, see table 61 of |
a7e8ffec GI |
1929 | T13/1699-D Revision 6a (ATA8-ACS). Note that the subcommands |
1930 | 0x00-0x04,0x7f,0x81-0x84 are supported by other smartctl options | |
1931 | (e.g. 0x01: \'\-t short\', 0x7f: \'\-X\', 0x82: \'\-C \-t long\'). | |
cfbba5b9 GI |
1932 | |
1933 | \fBWARNING: Only run subcommands documented by the vendor of the | |
1934 | device.\fP | |
1935 | ||
d2e702cf | 1936 | Example for some Intel SSDs only: |
a7e8ffec GI |
1937 | The subcommand 0x40 (\'\-t vendor,0x40\') clears the timed workload |
1938 | related SMART attributes (226, 227, 228). Note that the raw values of | |
1939 | these attributes are held at 65535 (0xffff) until the workload timer | |
1940 | reaches 60 minutes. | |
d008864d GI |
1941 | |
1942 | .I force | |
ee38a438 GI |
1943 | \- start new self-test even if another test is already running. |
1944 | By default a running self-test will not be interrupted to begin another | |
d008864d | 1945 | test. |
832b75ed GG |
1946 | .TP |
1947 | .B \-C, \-\-captive | |
ee38a438 | 1948 | [ATA] Runs self-tests in captive mode. This has no effect with \'\-t |
e9583e0c | 1949 | offline\' or if the \'\-t\' option is not used. |
832b75ed GG |
1950 | |
1951 | \fBWARNING: Tests run in captive mode may busy out the drive for the | |
1952 | length of the test. Only run captive tests on drives without any | |
1953 | mounted partitions!\fP | |
1954 | ||
ee38a438 | 1955 | [SCSI] Runs the self-test in "Foreground" mode. |
832b75ed GG |
1956 | .TP |
1957 | .B \-X, \-\-abort | |
ee38a438 | 1958 | Aborts non-captive SMART Self Tests. Note that this |
832b75ed GG |
1959 | command will abort the Offline Immediate Test routine only if your |
1960 | disk has the "Abort Offline collection upon new command" capability. | |
d2e702cf | 1961 | |
2127e193 GI |
1962 | .SH ATA, SCSI command sets and SAT |
1963 | In the past there has been a clear distinction between storage devices | |
1964 | that used the ATA and SCSI command sets. This distinction was often | |
1965 | reflected in their device naming and hardware. Now various SCSI | |
1966 | transports (e.g. SAS, FC and iSCSI) can interconnect to both SCSI | |
1967 | disks (e.g. FC and SAS) and ATA disks (especially SATA). USB and | |
1968 | IEEE 1394 storage devices use the SCSI command set externally but | |
1969 | almost always contain ATA or SATA disks (or flash). The storage | |
1970 | subsystems in some operating systems have started to remove the | |
1971 | distinction between ATA and SCSI in their device naming policies. | |
1972 | .PP | |
1973 | 99% of operations that an OS performs on a disk involve the SCSI INQUIRY, | |
1974 | READ CAPACITY, READ and WRITE commands, or their ATA equivalents. Since | |
1975 | the SCSI commands are slightly more general than their ATA equivalents, | |
1976 | many OSes are generating SCSI commands (mainly READ and WRITE) and | |
1977 | letting a lower level translate them to their ATA equivalents as the | |
1978 | need arises. An important note here is that "lower level" may be in | |
1979 | external equipment and hence outside the control of an OS. | |
1980 | .PP | |
1981 | SCSI to ATA Translation (SAT) is a standard (ANSI INCITS 431-2007) that | |
1982 | specifies how this translation is done. For the other 1% of operations | |
1983 | that an OS performs on a disk, SAT provides two options. First is an | |
1984 | optional ATA PASS-THROUGH SCSI command (there are two variants). The | |
1985 | second is a translation from the closest SCSI command. Most current | |
1986 | interest is in the "pass-through" option. | |
1987 | .PP | |
1988 | The relevance to smartmontools (and hence smartctl) is that its | |
1989 | interactions with disks fall solidly into the "1%" category. So even | |
1990 | if the OS can happily treat (and name) a disk as "SCSI", smartmontools | |
1991 | needs to detect the native command set and act accordingly. | |
1992 | As more storage manufacturers (including external SATA drives) comply | |
1993 | with SAT, smartmontools is able to automatically distinguish the native | |
1994 | command set of the device. In some cases the '\-d sat' option is needed | |
1995 | on the command line. | |
1996 | .PP | |
1997 | There are also virtual disks which typically have no useful information | |
1998 | to convey to smartmontools, but could conceivably in the future. An | |
1999 | example of a virtual disk is the OS's view of a RAID 1 box. There are | |
2000 | most likely two SATA disks inside a RAID 1 box. Addressing those SATA | |
2001 | disks from a distant OS is a challenge for smartmontools. Another | |
2002 | approach is running a tool like smartmontools inside the RAID 1 box (e.g. | |
2003 | a Network Attached Storage (NAS) box) and fetching the logs via a | |
2004 | browser. | |
d2e702cf | 2005 | |
832b75ed GG |
2006 | .SH EXAMPLES |
2007 | .nf | |
293b5ab8 | 2008 | .B smartctl \-a /dev/sda |
2127e193 | 2009 | .fi |
293b5ab8 | 2010 | Print a large amount of SMART information for drive /dev/sda . |
832b75ed GG |
2011 | .PP |
2012 | .nf | |
293b5ab8 | 2013 | .B smartctl \-s off /dev/sdd |
832b75ed | 2014 | .fi |
293b5ab8 | 2015 | Disable SMART monitoring and data log collection on drive /dev/sdd . |
832b75ed GG |
2016 | .PP |
2017 | .nf | |
293b5ab8 | 2018 | .B smartctl \-\-smart=on \-\-offlineauto=on \-\-saveauto=on /dev/sda |
832b75ed | 2019 | .fi |
293b5ab8 | 2020 | Enable SMART on drive /dev/sda, enable automatic offline |
832b75ed | 2021 | testing every four hours, and enable autosaving of |
ee38a438 | 2022 | SMART Attributes. This is a good start-up line for your system\'s |
832b75ed GG |
2023 | init files. You can issue this command on a running system. |
2024 | .PP | |
2025 | .nf | |
293b5ab8 | 2026 | .B smartctl \-t long /dev/sdc |
832b75ed | 2027 | .fi |
293b5ab8 | 2028 | Begin an extended self-test of drive /dev/sdc. You can issue this |
ee38a438 | 2029 | command on a running system. The results can be seen in the self-test |
832b75ed GG |
2030 | log visible with the \'\-l selftest\' option after it has completed. |
2031 | .PP | |
2032 | .nf | |
293b5ab8 | 2033 | .B smartctl \-s on \-t offline /dev/sda |
832b75ed GG |
2034 | .fi |
2035 | Enable SMART on the disk, and begin an immediate offline test of | |
293b5ab8 | 2036 | drive /dev/sda. You can issue this command on a running system. The |
832b75ed GG |
2037 | results are only used to update the SMART Attributes, visible |
2038 | with the \'\-A\' option. If any device errors occur, they are logged to | |
2039 | the SMART error log, which can be seen with the \'\-l error\' option. | |
2040 | .PP | |
2041 | .nf | |
293b5ab8 | 2042 | .B smartctl \-A \-v 9,minutes /dev/sda |
832b75ed | 2043 | .fi |
ee38a438 | 2044 | Shows the vendor Attributes, when the disk stores its power-on time |
832b75ed GG |
2045 | internally in minutes rather than hours. |
2046 | .PP | |
2047 | .nf | |
293b5ab8 | 2048 | .B smartctl \-q errorsonly \-H \-l selftest /dev/sda |
832b75ed GG |
2049 | .fi |
2050 | Produces output only if the device returns failing SMART status, | |
ee38a438 | 2051 | or if some of the logged self-tests ended with errors. |
832b75ed GG |
2052 | .PP |
2053 | .nf | |
293b5ab8 | 2054 | .B smartctl \-q silent \-a /dev/sda |
832b75ed | 2055 | .fi |
293b5ab8 | 2056 | Examine all SMART data for device /dev/sda, but produce no |
832b75ed GG |
2057 | printed output. You must use the exit status (the |
2058 | .B $? | |
2059 | shell variable) to learn if any Attributes are out of bound, if the | |
2060 | SMART status is failing, if there are errors recorded in the | |
ee38a438 | 2061 | self-test log, or if there are errors recorded in the disk error log. |
832b75ed GG |
2062 | .PP |
2063 | .nf | |
2064 | .B smartctl \-a \-d 3ware,0 /dev/sda | |
2065 | .fi | |
2066 | Examine all SMART data for the first ATA disk connected to a 3ware | |
2067 | RAID controller card. | |
2068 | .PP | |
2069 | .nf | |
2070 | .B smartctl \-a \-d 3ware,0 /dev/twe0 | |
2071 | .fi | |
2072 | Examine all SMART data for the first ATA disk connected to a 3ware | |
2073 | RAID 6000/7000/8000 controller card. | |
2074 | .PP | |
2075 | .nf | |
2076 | .B smartctl \-a \-d 3ware,0 /dev/twa0 | |
2077 | .fi | |
cfbba5b9 GI |
2078 | Examine all SMART data for the first ATA disk connected to a |
2079 | 3ware RAID 9000 controller card. | |
2080 | .PP | |
2081 | .nf | |
2082 | .B smartctl \-a \-d 3ware,0 /dev/twl0 | |
2083 | .fi | |
2084 | Examine all SMART data for the first SATA (not SAS) disk connected to a | |
2085 | 3ware RAID 9750 controller card. | |
832b75ed GG |
2086 | .PP |
2087 | .nf | |
2088 | .B smartctl \-t short \-d 3ware,3 /dev/sdb | |
2089 | .fi | |
ee38a438 | 2090 | Start a short self-test on the fourth ATA disk connected to the 3ware RAID |
832b75ed | 2091 | controller card which is the second SCSI device /dev/sdb. |
4d59bff9 GG |
2092 | .PP |
2093 | .nf | |
2127e193 GI |
2094 | .B smartctl \-t long \-d areca,4 /dev/sg2 |
2095 | .fi | |
ee38a438 | 2096 | Start a long self-test on the fourth SATA disk connected to an Areca RAID |
2127e193 GI |
2097 | controller addressed by /dev/sg2. |
2098 | .PP | |
2099 | .nf | |
2100 | .B smartctl \-a \-d hpt,1/3 /dev/sda (under Linux) | |
2101 | .B smartctl \-a \-d hpt,1/3 /dev/hptrr (under FreeBSD) | |
4d59bff9 GG |
2102 | .fi |
2103 | Examine all SMART data for the (S)ATA disk directly connected to the third channel of the | |
2104 | first HighPoint RocketRAID controller card. | |
2105 | .nf | |
2106 | .PP | |
2107 | .nf | |
2127e193 GI |
2108 | .B smartctl \-t short \-d hpt,1/1/2 /dev/sda (under Linux) |
2109 | .B smartctl \-t short \-d hpt,1/1/2 /dev/hptrr (under FreeBSD) | |
4d59bff9 | 2110 | .fi |
ee38a438 | 2111 | Start a short self-test on the (S)ATA disk connected to second pmport on the |
4d59bff9 GG |
2112 | first channel of the first HighPoint RocketRAID controller card. |
2113 | .PP | |
832b75ed | 2114 | .nf |
293b5ab8 | 2115 | .B smartctl \-t select,10\-100 \-t select,30\-300 \-t afterselect,on \-t pending,45 /dev/sda |
832b75ed | 2116 | .fi |
ee38a438 GI |
2117 | Run a selective self-test on LBAs 10 to 100 and 30 to 300. After the |
2118 | these LBAs have been tested, read-scan the remainder of the disk. If the disk is | |
2119 | power-cycled during the read-scan, resume the scan 45 minutes after power to the | |
832b75ed GG |
2120 | device is restored. |
2121 | .PP | |
ba59cff1 GG |
2122 | .nf |
2123 | .B smartctl \-a \-d cciss,0 /dev/cciss/c0d0 | |
2124 | .fi | |
2125 | Examine all SMART data for the first SCSI disk connected to a cciss | |
2126 | RAID controller card. | |
d2e702cf | 2127 | |
293b5ab8 JD |
2128 | .SH EXIT STATUS |
2129 | The exit statuses of \fBsmartctl\fP are defined by a bitmask. | |
2130 | If all is well with the disk, the exit status (return value) of | |
832b75ed | 2131 | \fBsmartctl\fP is 0 (all bits turned off). If a problem occurs, or an |
ee38a438 | 2132 | error, potential error, or fault is detected, then a non-zero status |
293b5ab8 JD |
2133 | is returned. In this case, the eight different bits in the exit status |
2134 | have the following meanings for ATA disks; some of these values | |
832b75ed GG |
2135 | may also be returned for SCSI disks. |
2136 | .TP | |
2137 | .B Bit 0: | |
2138 | Command line did not parse. | |
2139 | .TP | |
2140 | .B Bit 1: | |
cfbba5b9 GI |
2141 | Device open failed, device did not return an IDENTIFY DEVICE structure, |
2142 | or device is in a low-power mode (see \'\-n\' option above). | |
832b75ed GG |
2143 | .TP |
2144 | .B Bit 2: | |
d008864d GI |
2145 | Some SMART or other ATA command to the disk failed, or there was a checksum |
2146 | error in a SMART data structure (see \'\-b\' option above). | |
832b75ed GG |
2147 | .TP |
2148 | .B Bit 3: | |
2149 | SMART status check returned "DISK FAILING". | |
2150 | .TP | |
2151 | .B Bit 4: | |
a37e7145 | 2152 | We found prefail Attributes <= threshold. |
832b75ed GG |
2153 | .TP |
2154 | .B Bit 5: | |
2155 | SMART status check returned "DISK OK" but we found that some (usage | |
2156 | or prefail) Attributes have been <= threshold at some time in the | |
2157 | past. | |
2158 | .TP | |
2159 | .B Bit 6: | |
2160 | The device error log contains records of errors. | |
2161 | .TP | |
2162 | .B Bit 7: | |
ee38a438 | 2163 | The device self-test log contains records of errors. |
cfbba5b9 | 2164 | [ATA only] Failed self-tests outdated by a newer successful extended |
ee38a438 | 2165 | self-test are ignored. |
d008864d | 2166 | .PP |
832b75ed | 2167 | To test within the shell for whether or not the different bits are |
d2e702cf GI |
2168 | turned on or off, you can use the following type of construction |
2169 | (which should work with any POSIX compatible shell): | |
832b75ed GG |
2170 | .nf |
2171 | .B smartstat=$(($? & 8)) | |
2172 | .fi | |
2173 | This looks at only at bit 3 of the exit status | |
2174 | .B $? | |
2175 | (since 8=2^3). The shell variable | |
2176 | $smartstat will be nonzero if SMART status check returned "disk | |
2177 | failing" and zero otherwise. | |
d2e702cf GI |
2178 | .PP |
2179 | This shell script prints all status bits: | |
d008864d | 2180 | .nf |
d2e702cf GI |
2181 | val=$?; mask=1 |
2182 | for i in 0 1 2 3 4 5 6 7; do | |
2183 | echo "Bit $i: $(((val & mask) && 1))" | |
2184 | mask=$((mask << 1)) | |
d008864d GI |
2185 | done |
2186 | .fi | |
2187 | ||
d2e702cf GI |
2188 | .\" %IF NOT OS Windows |
2189 | .SH FILES | |
2190 | .TP | |
2191 | .B /usr/local/sbin/smartctl | |
2192 | full path of this executable. | |
2193 | .\" %IF ENABLE_DRIVEDB | |
2194 | .TP | |
2195 | .B /usr/local/share/smartmontools/drivedb.h | |
2196 | drive database (see \'\-B\' option). | |
2197 | .\" %ENDIF ENABLE_DRIVEDB | |
2198 | .TP | |
2199 | .B /usr/local/etc/smart_drivedb.h | |
2200 | optional local drive database (see \'\-B\' option). | |
2201 | ||
2202 | .\" %ENDIF NOT OS Windows | |
ee38a438 | 2203 | .SH AUTHORS |
293b5ab8 | 2204 | \fBBruce Allen\fP (project initiator), |
d2e702cf | 2205 | .br |
293b5ab8 | 2206 | \fBChristian Franke\fP (project manager, Windows port and all sort of things), |
d2e702cf | 2207 | .br |
293b5ab8 | 2208 | \fBDouglas Gilbert\fP (SCSI subsystem), |
d2e702cf | 2209 | .br |
293b5ab8 | 2210 | \fBVolker Kuhlmann\fP (moderator of support and database mailing list), |
d2e702cf | 2211 | .br |
293b5ab8 | 2212 | \fBGabriele Pohl\fP (wiki & development team support), |
d2e702cf | 2213 | .br |
293b5ab8 JD |
2214 | \fBAlex Samorukov\fP (FreeBSD port and more, new Trac wiki). |
2215 | ||
2216 | Many other individuals have made contributions and corrections, | |
2217 | see AUTHORS, ChangeLog and repository files. | |
2218 | ||
2219 | The first smartmontools code was derived from the smartsuite package, | |
2220 | written by Michael Cornwell and Andre Hedrick. | |
2221 | ||
2222 | .SH REPORTING BUGS | |
2223 | To submit a bug report, create a ticket in smartmontools wiki: | |
d2e702cf | 2224 | .br |
293b5ab8 | 2225 | <\fBhttp://www.smartmontools.org/\fP>. |
d2e702cf | 2226 | .br |
293b5ab8 | 2227 | Alternatively send the info to the smartmontools support mailing list: |
d2e702cf | 2228 | .br |
293b5ab8 | 2229 | <\fBhttps://lists.sourceforge.net/lists/listinfo/smartmontools-support\fB>. |
832b75ed | 2230 | |
d2e702cf GI |
2231 | .SH SEE ALSO |
2232 | \fBsmartd\fP(8), \fBupdate-smart-drivedb\fP(8). | |
2233 | ||
2234 | .SH REFERENCES | |
2235 | Please see the following web site for more info: | |
6b80b4d2 | 2236 | \fBhttp://www.smartmontools.org/\fP |
d2e702cf | 2237 | |
832b75ed GG |
2238 | An introductory article about smartmontools is \fIMonitoring Hard |
2239 | Disks with SMART\fP, by Bruce Allen, Linux Journal, January 2004, | |
ee38a438 | 2240 | pages 74-77. This is \fBhttp://www.linuxjournal.com/article/6983\fP |
832b75ed GG |
2241 | online. |
2242 | ||
2243 | If you would like to understand better how SMART works, and what it | |
2244 | does, a good place to start is with Sections 4.8 and 6.54 of the first | |
ee38a438 | 2245 | volume of the \'AT Attachment with Packet Interface-7\' (ATA/ATAPI-7) |
e9583e0c GI |
2246 | specification Revision 4b. This documents the SMART functionality which the |
2247 | \fBsmartmontools\fP utilities provide access to. | |
832b75ed | 2248 | |
ee38a438 GI |
2249 | The functioning of SMART was originally defined by the SFF-8035i |
2250 | revision 2 and the SFF-8055i revision 1.4 specifications. These are | |
e9583e0c GI |
2251 | publications of the Small Form Factors (SFF) Committee. |
2252 | ||
2253 | Links to these and other documents may be found on the Links page of the | |
d2e702cf | 2254 | \fBsmartmontools\fP Wiki at \fBhttp://www.smartmontools.org/wiki/Links\fP . |
832b75ed | 2255 | |
293b5ab8 JD |
2256 | .SH PACKAGE VERSION |
2257 | CURRENT_SVN_VERSION CURRENT_SVN_DATE CURRENT_SVN_REV | |
2258 | .br | |
6b80b4d2 | 2259 | $Id: smartctl.8.in 4120 2015-08-27 16:12:21Z samm2 $ |