~ubuntu-branches/ubuntu/natty/smartmontools/natty : revision 22

1

.ig

2

3

4

$Id: smartd.conf.5.in 3075 2010-03-12 22:01:44Z chrfranke $

5

6

This program is free software; you can redistribute it and/or modify it

7

under the terms of the GNU General Public License as published by the Free

8

Software Foundation; either version 2, or (at your option) any later

9

version.

10

11

You should have received a copy of the GNU General Public License (for

12

example COPYING); if not, write to the Free Software Foundation, Inc., 675

13

Mass Ave, Cambridge, MA 02139, USA.

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/

19

..

20

.TH SMARTD.CONF 5 CURRENT_CVS_DATE CURRENT_CVS_VERSION CURRENT_CVS_DATE

21

.SH NAME

22

\fBsmartd.conf\fP \- SMART Disk Monitoring Daemon Configuration File\fP

23

24

.SH FULL PATH

25

.B /usr/local/etc/smartd.conf

26

27

.SH PACKAGE VERSION

28

CURRENT_CVS_VERSION released CURRENT_CVS_DATE at CURRENT_CVS_TIME

29

30

.SH DESCRIPTION

31

\fB/usr/local/etc/smartd.conf\fP is the configuration file for the \fBsmartd\fP

32

daemon, which monitors the Self-Monitoring, Analysis and Reporting

33

Technology (SMART) system built into many ATA-3 and later ATA, IDE and

34

SCSI-3 hard drives.

35

36

If the configuration file \fB/usr/local/etc/smartd.conf\fP is present,

37

\fBsmartd\fP reads it at startup, before \fBfork\fP(2)ing into the

38

background. If \fBsmartd\fP subsequently receives a \fBHUP\fP signal,

39

it will then re-read the configuration file. If \fBsmartd\fP is

40

running in debug mode, then an \fBINT\fP signal will also make it

41

re-read the configuration file. This signal can be generated by typing

42

\fB\<CONTROL-C\>\fP in the terminal window where \fBsmartd\fP is

43

running.

44

45

.\" DO NOT MODIFY THIS OR THE FOLLOWING TWO LINES. WHAT FOLLOWS

46

.\" IS AUTOMATICALLY INCLUDED FROM THE FILE smartd.8.in

47

.\" STARTINCLUDE

48

49

.SH CONFIGURATION FILE /usr/local/etc/smartd.conf

50

In the absence of a configuration file, under Linux

51

\fBsmartd\fP

52

will try to open the 20 ATA devices

53

.B /dev/hd[a-t]

54

and the 26 SCSI devices

55

.B /dev/sd[a-z].

56

Under FreeBSD,

57

\fBsmartd\fP

58

will try to open all existing ATA devices (with entries in /dev)

59

.B /dev/ad[0-9]+

60

and all existing SCSI devices (using CAM subsystem).

61

Under NetBSD/OpenBSD,

62

\fBsmartd\fP

63

will try to open all existing ATA devices (with entries in /dev)

64

.B /dev/wd[0-9]+c

65

and all existing SCSI devices

66

.B /dev/sd[0-9]+c.

67

Under Solaris \fBsmartd\fP will try to open all entries \fB"/dev/rdsk/c?t?d?s?"\fP for IDE/ATA and SCSI disk

68

devices, and entries \fB"/dev/rmt/*"\fP for SCSI tape devices.

69

Under Windows \fBsmartd\fP will try to open all entries \fB"/dev/hd[a-j]"\fP ("\\\\.\\PhysicalDrive[0-9]")

70

for IDE/ATA devices on WinNT4/2000/XP, \fB"/dev/hd[a-d]"\fP

71

(bitmask from "\\\\.\\SMARTVSD") for IDE/ATA devices on Win95/98/98SE/ME,

72

and \fB"/dev/scsi[0-9][0-7]"\fP (ASPI adapter 0-9, ID 0-7) for SCSI

73

devices on all versions of Windows.

74

Under Darwin, \fBsmartd\fP will open any ATA block storage device.

75

76

This can be annoying if you have an ATA or SCSI device that hangs or

77

misbehaves when receiving SMART commands. Even if this causes no

78

problems, you may be annoyed by the string of error log messages about

79

block-major devices that can\'t be found, and SCSI devices that can\'t

80

be opened.

81

82

One can avoid this problem, and gain more control over the types of

83

events monitored by

84

\fBsmartd\fP,

85

by using the configuration file

86

.B /usr/local/etc/smartd.conf.

87

This file contains a list of devices to monitor, with one device per

88

line. An example file is included with the

89

.B smartmontools

90

distribution. You will find this sample configuration file in

91

\fB/usr/local/share/doc/smartmontools-5.1/\fP. For security, the configuration file

92

should not be writable by anyone but root. The syntax of the file is as

93

follows:

94

.IP \(bu 4

95

There should be one device listed per line, although you may have

96

lines that are entirely comments or white space.

97

.IP \(bu 4

98

Any text following a hash sign \'#\' and up to the end of the line is

99

taken to be a comment, and ignored.

100

.IP \(bu 4

101

Lines may be continued by using a backslash \'\e\' as the last

102

non-whitespace or non-comment item on a line.

103

.IP \(bu 4

104

Note: a line whose first character is a hash sign \'#\' is treated as

105

a white-space blank line, \fBnot\fP as a non-existent line, and will

106

\fBend\fP a continuation line.

107

.PP 0

108

.fi

109

Here is an example configuration file. It\'s for illustrative purposes

110

only; please don\'t copy it onto your system without reading to the end

111

of the

112

.B DIRECTIVES

113

Section below!

114

115

.nf

116

.B ################################################

117

.B # This is an example smartd startup config file

118

.B # /usr/local/etc/smartd.conf for monitoring three

119

.B # ATA disks, three SCSI disks, six ATA disks

120

.B # behind two 3ware controllers, three SATA disks

121

.B # directly connected to the HighPoint Rocket-

122

.B # RAID controller, two SATA disks connected to

123

.B # the HighPoint RocketRAID controller via a pmport

124

.B # device, four SATA disks connected to an Areca

125

.B # RAID controller, and one SATA disk.

126

.B #

127

.nf

128

.B # First ATA disk on two different interfaces. On

129

.B # the second disk, start a long self-test every

130

.B # Sunday between 3 and 4 am.

131

.B #

132

.B \ \ /dev/hda -a -m admin@example.com,root@localhost

133

.B \ \ /dev/hdc -a -I 194 -I 5 -i 12 -s L/../../7/03

134

.B #

135

.nf

136

.B # SCSI disks. Send a TEST warning email to admin on

137

.B # startup.

138

.B #

139

.B \ \ /dev/sda

140

.B \ \ /dev/sdb -m admin@example.com -M test

141

.B #

142

.nf

143

.B # Strange device. It\'s SCSI. Start a scheduled

144

.B # long self test between 5 and 6 am Monday/Thursday

145

.B \ \ /dev/weird -d scsi -s L/../../(1|4)/05

146

.B #

147

.nf

148

.B # An ATA disk may appear as a SCSI device to the

149

.B # OS. If a SCSI to ATA Translation (SAT) layer

150

.B # is between the OS and the device then this can be

151

.B # flagged with the '-d sat' option. This situation

152

.B # may become common with SATA disks in SAS and FC

153

.B # environments.

154

.B \ \ /dev/sda -a -d sat

155

.B #

156

.nf

157

.B # Three disks connected to a MegaRAID controller

158

.B # Start short self-tests daily between 1-2, 2-3, and

159

.B # 3-4 am.

160

.B \ \ /dev/sda -d megaraid,0 -a -s S/../.././01

161

.B \ \ /dev/sda -d megaraid,1 -a -s S/../.././02

162

.B \ \ /dev/sda -d megaraid,2 -a -s S/../.././03

163

.B

164

.B #

165

.nf

166

.B # Four ATA disks on a 3ware 6/7/8000 controller.

167

.B # Start short self-tests daily between midnight and 1am,

168

.B # 1-2, 2-3, and 3-4 am. Starting with the Linux 2.6

169

.B # kernel series, /dev/sdX is deprecated in favor of

170

.B # /dev/tweN. For example replace /dev/sdc by /dev/twe0

171

.B # and /dev/sdd by /dev/twe1.

172

.B \ \ /dev/sdc -d 3ware,0 -a -s S/../.././00

173

.B \ \ /dev/sdc -d 3ware,1 -a -s S/../.././01

174

.B \ \ /dev/sdd -d 3ware,2 -a -s S/../.././02

175

.B \ \ /dev/sdd -d 3ware,3 -a -s S/../.././03

176

.B #

177

.nf

178

.B # Two ATA disks on a 3ware 9000 controller.

179

.B # Start long self-tests Sundays between midnight and

180

.B # 1am and 2-3 am

181

.B \ \ /dev/twa0 -d 3ware,0 -a -s L/../../7/00

182

.B \ \ /dev/twa0 -d 3ware,1 -a -s L/../../7/02

183

.B #

184

.nf

185

.B # Three SATA disks on a HighPoint RocketRAID controller.

186

.B # Start short self-tests daily between 1-2, 2-3, and

187

.B # 3-4 am.

188

.B # under Linux

189

.B \ \ /dev/sde -d hpt,1/1 -a -s S/../.././01

190

.B \ \ /dev/sde -d hpt,1/2 -a -s S/../.././02

191

.B \ \ /dev/sde -d hpt,1/3 -a -s S/../.././03

192

.B # or under FreeBSD

193

.B # /dev/hptrr -d hpt,1/1 -a -s S/../.././01

194

.B # /dev/hptrr -d hpt,1/2 -a -s S/../.././02

195

.B # /dev/hptrr -d hpt,1/3 -a -s S/../.././03

196

.B #

197

.nf

198

.B # Two SATA disks connected to a HighPoint RocketRAID

199

.B # via a pmport device. Start long self-tests Sundays

200

.B # between midnight and 1am and 2-3 am.

201

.B # under Linux

202

.B \ \ /dev/sde -d hpt,1/4/1 -a -s L/../../7/00

203

.B \ \ /dev/sde -d hpt,1/4/2 -a -s L/../../7/02

204

.B # or under FreeBSD

205

.B # /dev/hptrr -d hpt,1/4/1 -a -s L/../../7/00

206

.B # /dev/hptrr -d hpt,1/4/2 -a -s L/../../7/02

207

.B #

208

.nf

209

.B # Three SATA disks connected to an Areca

210

.B # RAID controller. Start long self-tests Sundays

211

.B # between midnight and 3 am.

212

.B \ \ /dev/sg2 -d areca,1 -a -s L/../../7/00

213

.B \ \ /dev/sg2 -d areca,2 -a -s L/../../7/01

214

.B \ \ /dev/sg2 -d areca,3 -a -s L/../../7/02

215

.B #

216

.nf

217

.B # The following line enables monitoring of the

218

.B # ATA Error Log and the Self-Test Error Log.

219

.B # It also tracks changes in both Prefailure

220

.B # and Usage Attributes, apart from Attributes

221

.B # 9, 194, and 231, and shows continued lines:

222

.B #

223

.B \ \ /dev/hdd\ -l\ error\ \e

224

.B \ \ \ \ \ \ \ \ \ \ \ -l\ selftest\ \e

225

.B \ \ \ \ \ \ \ \ \ \ \ -t\ \e\ \ \ \ \ \ # Attributes not tracked:

226

.B \ \ \ \ \ \ \ \ \ \ \ -I\ 194\ \e\ \ # temperature

227

.B \ \ \ \ \ \ \ \ \ \ \ -I\ 231\ \e\ \ # also temperature

228

.B \ \ \ \ \ \ \ \ \ \ \ -I 9\ \ \ \ \ \ # power-on hours

229

.B #

230

.B ################################################

231

.fi

232

233

.PP

234

.SH CONFIGURATION FILE DIRECTIVES

235

.PP

236

237

If a non-comment entry in the configuration file is the text string

238

.B DEVICESCAN

239

in capital letters, then

240

\fBsmartd\fP

241

will ignore any remaining lines in the configuration file, and will

242

scan for devices.

243

.B DEVICESCAN

244

may optionally be followed by Directives that will apply to all

245

devices that are found in the scan. Please see below for additional

246

details.

247

248

.sp 2

249

The following are the Directives that may appear following the device

250

name or

251

.B DEVICESCAN

252

on any line of the

253

.B /usr/local/etc/smartd.conf

254

configuration file. Note that

255

.B these are NOT command-line options for

256

\fBsmartd\fP.

257

The Directives below may appear in any order, following the device

258

name.

259

260

.B For an ATA device,

261

if no Directives appear, then the device will be monitored

262

as if the \'\-a\' Directive (monitor all SMART properties) had been given.

263

264

.B If a SCSI disk is listed,

265

it will be monitored at the maximum implemented level: roughly

266

equivalent to using the \'\-H \-l selftest\' options for an ATA disk.

267

So with the exception of \'\-d\', \'\-m\', \'\-l selftest\', \'\-s\', and

268

\'\-M\', the Directives below are ignored for SCSI disks. For SCSI

269

disks, the \'\-m\' Directive sends a warning email if the SMART status

270

indicates a disk failure or problem, if the SCSI inquiry about disk

271

status fails, or if new errors appear in the self-test log.

272

273

.B If a 3ware controller is used

274

then the corresponding SCSI (/dev/sd?) or character device (/dev/twe?

275

or /dev/twa?) must be listed, along with the \'\-d 3ware,N\' Directive

276

(see below). The individual ATA disks hosted by the 3ware controller

277

appear to \fBsmartd\fP as normal ATA devices. Hence all the ATA

278

directives can be used for these disks (but see note below).

279

280

.B If an Areca controller is used

281

then the corresponding SCSI generic device (/dev/sg?) must be listed,

282

along with the \'\-d areca,N\' Directive (see below). The individual

283

SATA disks hosted by the Areca controller appear to \fBsmartd\fP as

284

normal ATA devices. Hence all the ATA directives can be used for

285

these disks. Areca firmware version 1.46 or later which supports

286

smartmontools must be used; Please see the \fBsmartctl\fP(8) man page

287

for further details.

288

289

.TP

290

.B \-d TYPE

291

Specifies the type of the device. This Directive may be used multiple

292

times for one device, but the arguments \fIata\fP, \fIscsi\fP,

293

\fIsat\fP, \fImarvell\fP, \fIcciss,N\fP, \fIareca,N\fP, \fImegaraid,N\fP

294

and \fI3ware,N\fP are mutually-exclusive. If more than one is given then

295

\fBsmartd\fP will use the last one which appears.

296

297

If none of these three arguments is given, then \fBsmartd\fP will

298

first attempt to guess the device type by looking at whether the sixth

299

character in the device name is an \'s\' or an \'h\'. This will work for

300

device names like /dev/hda or /dev/sdb, and corresponds to choosing

301

\fIata\fP or \fIscsi\fP respectively. If

302

\fBsmartd\fP

303

can\'t guess from this sixth character, then it will simply try to

304

access the device using first ATA and then SCSI ioctl()s.

305

306

The valid arguments to this Directive are:

307

308

.I ata

309

\- the device type is ATA. This prevents

310

\fBsmartd\fP

311

from issuing SCSI commands to an ATA device.

312

313

.I scsi

314

\- the device type is SCSI. This prevents

315

\fBsmartd\fP

316

from issuing ATA commands to a SCSI device.

317

318

.I sat

319

\- the device type is SCSI to ATA Translation (SAT).

320

\fBsmartd\fP

321

will generate ATA (smart) commands and then package them in

322

the SAT defined ATA PASS THROUGH SCSI commands. The commands

323

are then routed through the SCSI pass through interface to the

324

operating system. There are two types of ATA PASS THROUGH

325

SCSI commands: a 12 byte and 16 byte variant.

326

\fBsmartd\fP

327

can use either and defaults to the 16 byte variant. This can

328

be overridden with this syntax: \'\-d sat,12\' or \'\-d sat,16\'.

329

330

.I marvell

331

\- Under Linux, interact with SATA disks behind Marvell chip-set

332

controllers (using the Marvell rather than libata driver).

333

334

.I megaraid,N

335

\- the device consists of one or more SCSI/SAS/SATA disks connected

336

to a MegaRAID controller. The non-negative integer N (in the range

337

of 0 to 127 inclusive) denotes which disk on the controller is monitored.

338

In log files and email messages this disk will be identified as

339

megaraid_disk_XXX with XXX in the range from 000 to 127 inclusive.

340

341

.I 3ware,N

342

\- the device consists of one or more ATA disks connected to a 3ware

343

RAID controller. The non-negative integer N (in the range from 0 to 127

344

inclusive) denotes which disk on the controller is monitored. In log

345

files and email messages this disk will be identified as 3ware_disk_XXX

346

with XXX in the range from 000 to 127 inclusive.

347

348

This Directive may at first appear confusing, because the 3ware

349

controller is a SCSI device (such as /dev/sda) and should be listed as

350

such in the the configuration file.

351

However when the \'\-d 3ware,N\'

352

Directive is used, then the corresponding disk is addressed using

353

native ATA commands which are \'passed through\' the SCSI driver. All

354

ATA Directives listed in this man page may be used. Note that while

355

you may use \fBany\fP of the 3ware SCSI logical devices /dev/sd? to

356

address \fBany\fP of the physical disks (3ware ports), error and log

357

messages will make the most sense if you always list the 3ware SCSI

358

logical device corresponding to the particular physical disks. Please

359

see the \fBsmartctl\fP(8) man page for further details.

360

361

ATA disks behind 3ware controllers may alternatively be accessed via a

362

character device interface /dev/twe0-15 (3ware 6000/7000/8000

363

controllers) and /dev/twa0-15 (3ware 9000 series controllers). Note

364

that the 9000 series controllers may \fBonly\fP be accessed using the

365

character device interface /dev/twa0-15 and not the SCSI device

366

interface /dev/sd?. Please see the \fBsmartctl\fP(8) man page for

367

further details.

368

369

Note that older 3w-xxxx drivers do not pass the \'Enable Autosave\'

370

(\fB-S on\fP) and \'Enable Automatic Offline\' (\fB-o on\fP) commands

371

to the disk, if the SCSI interface is used, and produce these types of

372

harmless syslog error messages instead: \fB\'3w-xxxx: tw_ioctl():

373

Passthru size (123392) too big\'\fP. This can be fixed by upgrading to

374

version 1.02.00.037 or later of the 3w-xxxx driver, or by applying a

375

patch to older versions. See

376

\fBhttp://smartmontools.sourceforge.net/\fP for instructions.

377

Alternatively use the character device interfaces /dev/twe0-15 (3ware

378

6/7/8000 series controllers) or /dev/twa0-15 (3ware 9000 series

379

controllers).

380

381

.I areca,N

382

\- the device consists of one or more SATA disks connected to an Areca

383

SATA RAID controller. The positive integer N (in the range from 1 to

384

24 inclusive) denotes which disk on the controller is monitored. In

385

log files and email messages this disk will be identifed as

386

areca_disk_XX with XX in the range from 01 to 24 inclusive.

387

388

.I cciss,N

389

\- the device consists of one or more SCSI disks connected to a cciss

390

RAID controller. The non-negative integer N (in the range from 0 to 15

391

inclusive) denotes which disk on the controller is monitored. In log

392

files and email messages this disk will be identified as cciss_disk_XX

393

with XX in the range from 00 to 15 inclusive.

394

395

.B 3ware, MegaRAID, Areca and cciss controllers are currently ONLY supported under Linux.

396

397

.I hpt,L/M/N

398

\- the device consists of one or more ATA disks connected to a HighPoint

399

RocketRAID controller. The integer L is the controller id, the integer M

400

is the channel number, and the integer N is the PMPort number if it is

401

available. The allowed values of L are from 1 to 4 inclusive, M are from

402

1 to 8 inclusive and N from 1 to 4 if PMPort available. And also these

403

values are limited by the model of the HighPoint RocketRAID controller.

404

In log files and email messages this disk will be identified as

405

hpt_X/X/X and X/X/X is the same as L/M/N, note if no N indicated, N set

406

to the default value 1.

407

408

.B HighPoint RocketRAID controllers are currently ONLY supported under Linux and FreeBSD.

409

410

.I removable

411

\- the device or its media is removable. This indicates to

412

\fBsmartd\fP

413

that it should continue (instead of exiting, which is the default

414

behavior) if the device does not appear to be present when

415

\fBsmartd\fP is started. This Directive may be used in conjunction

416

with the other \'\-d\' Directives.

417

418

.TP

419

.B \-n POWERMODE[,N][,q]

420

This \'nocheck\' Directive is used to prevent a disk from being

421

spun-up when it is periodically polled by \fBsmartd\fP.

422

423

ATA disks have five different power states. In order of increasing

424

power consumption they are: \'OFF\', \'SLEEP\', \'STANDBY\', \'IDLE\',

425

and \'ACTIVE\'. Typically in the OFF, SLEEP, and STANDBY modes the

426

disk\'s platters are not spinning. But usually, in response to SMART

427

commands issued by \fBsmartd\fP, the disk platters are spun up. So if

428

this option is not used, then a disk which is in a low\-power mode may

429

be spun up and put into a higher\-power mode when it is periodically

430

polled by \fBsmartd\fP.

431

432

Note that if the disk is in SLEEP mode when \fBsmartd\fP is started,

433

then it won't respond to \fBsmartd\fP commands, and so the disk won't

434

be registered as a device for \fBsmartd\fP to monitor. If a disk is in

435

any other low\-power mode, then the commands issued by \fBsmartd\fP to

436

register the disk will probably cause it to spin\-up.

437

438

The \'\fB\-n\fP\' (nocheck) Directive specifies if \fBsmartd\fP\'s

439

periodic checks should still be carried out when the device is in a

440

low\-power mode. It may be used to prevent a disk from being spun\-up

441

by periodic \fBsmartd\fP polling. The allowed values of POWERMODE

442

are:

443

444

.I never

445

\- \fBsmartd\fP will poll (check) the device regardless of its power

446

mode. This may cause a disk which is spun\-down to be spun\-up when

447

\fBsmartd\fP checks it. This is the default behavior if the '\-n'

448

Directive is not given.

449

450

.I sleep

451

\- check the device unless it is in SLEEP mode.

452

453

.I standby

454

\- check the device unless it is in SLEEP or STANDBY mode. In

455

these modes most disks are not spinning, so if you want to prevent

456

a laptop disk from spinning up each time that \fBsmartd\fP polls,

457

this is probably what you want.

458

459

.I idle

460

\- check the device unless it is in SLEEP, STANDBY or IDLE mode.

461

In the IDLE state, most disks are still spinning, so this is probably

462

not what you want.

463

464

Maximum number of skipped checks (in a row) can be specified by

465

appending positive number \',N\' to POWERMODE (like \'\-n standby,15\').

466

After N checks are skipped in a row, powermode is ignored and the

467

check is performed anyway.

468

469

When a periodic test is skipped, \fBsmartd\fP normally writes an

470

informal log message. The message can be suppressed by appending

471

the option \',q\' to POWERMODE (like \'\-n standby,q\').

472

This prevents a laptop disk from spinning up due to this message.

473

474

Both \',N\' and \',q\' can be specified together.

475

476

.TP

477

.B \-T TYPE

478

Specifies how tolerant

479

\fBsmartd\fP

480

should be of SMART command failures. The valid arguments to this

481

Directive are:

482

483

.I normal

484

\- do not try to monitor the disk if a mandatory SMART command fails, but

485

continue if an optional SMART command fails. This is the default.

486

487

.I permissive

488

\- try to monitor the disk even if it appears to lack SMART

489

capabilities. This may be required for some old disks (prior to

490

ATA\-3 revision 4) that implemented SMART before the SMART standards

491

were incorporated into the ATA/ATAPI Specifications. This may also be

492

needed for some Maxtor disks which fail to comply with the ATA

493

Specifications and don't properly indicate support for error\- or

494

self\-test logging.

495

496

[Please see the \fBsmartctl \-T\fP command-line option.]

497

.TP

498

.B \-o VALUE

499

Enables or disables SMART Automatic Offline Testing when

500

\fBsmartd\fP

501

starts up and has no further effect. The valid arguments to this

502

Directive are \fIon\fP and \fIoff\fP.

503

504

The delay between tests is vendor-specific, but is typically four

505

hours.

506

507

Note that SMART Automatic Offline Testing is \fBnot\fP part of the ATA

508

Specification. Please see the

509

.B smartctl \-o

510

command-line option documentation for further information about this

511

feature.

512

.TP

513

.B \-S VALUE

514

Enables or disables Attribute Autosave when \fBsmartd\fP

515

starts up and has no further effect. The valid arguments to this

516

Directive are \fIon\fP and \fIoff\fP. Also affects SCSI devices.

517

[Please see the \fBsmartctl \-S\fP command-line option.]

518

.TP

519

.B \-H

520

Check the SMART health status of the disk. If any Prefailure

521

Attributes are less than or equal to their threshold values, then disk

522

failure is predicted in less than 24 hours, and a message at loglevel

523

.B \'LOG_CRITICAL\'

524

will be logged to syslog. [Please see the

525

.B smartctl \-H

526

command-line option.]

527

.TP

528

.B \-l TYPE

529

Reports increases in the number of errors in one of the two SMART logs. The

530

valid arguments to this Directive are:

531

532

.I error

533

\- report if the number of ATA errors reported in the ATA Error Log

534

has increased since the last check.

535

536

.I selftest

537

\- report if the number of failed tests reported in the SMART

538

Self-Test Log has increased since the last check, or if the timestamp

539

associated with the most recent failed test has increased. Note that

540

such errors will \fBonly\fP be logged if you run self-tests on the

541

disk (and it fails a test!). Self-Tests can be run automatically by

542

\fBsmartd\fP: please see the \fB\'\-s\'\fP Directive below.

543

Self-Tests can also be run manually by using the \fB\'\-t\ short\'\fP

544

and \fB\'\-t\ long\'\fP options of \fBsmartctl\fP and the results of

545

the testing can be observed using the \fBsmartctl \'\-l\ selftest\'\fP

546

command-line option.]

547

548

[Please see the \fBsmartctl \-l\fP and \fB\-t\fP command-line

549

options.]

550

.TP

551

.B \-s REGEXP

552

Run Self-Tests or Offline Immediate Tests, at scheduled times. A

553

Self- or Offline Immediate Test will be run at the end of periodic

554

device polling, if all 12 characters of the string \fBT/MM/DD/d/HH\fP

555

match the extended regular expression \fBREGEXP\fP. Here:

556

.RS 7

557

.IP \fBT\fP 4

558

is the type of the test. The values that \fBsmartd\fP will try to

559

match (in turn) are: \'L\' for a \fBL\fPong Self-Test, \'S\' for a

560

\fBS\fPhort Self-Test, \'C\' for a \fBC\fPonveyance Self-Test (ATA

561

only), and \'O\' for an \fBO\fPffline Immediate Test (ATA only). As

562

soon as a match is found, the test will be started and no additional

563

matches will be sought for that device and that polling cycle.

564

565

[NEW EXPERIMENTAL SMARTD FEATURE] To run scheduled Selective

566

Self-Tests, use \'n\' for \fBn\fPext span, \'r\' to \fBr\fPedo last

567

span, or \'c\' to \fBc\fPontinue with next span or redo last span

568

based on status of last test. The LBA range is based on the first

569

span from the last test.

570

See the \fBsmartctl \-t select,[next|redo|cont]\fP options for

571

further info.

572

573

.IP \fBMM\fP 4

574

is the month of the year, expressed with two decimal digits. The

575

range is from 01 (January) to 12 (December) inclusive. Do \fBnot\fP

576

use a single decimal digit or the match will always fail!

577

.IP \fBDD\fP 4

578

is the day of the month, expressed with two decimal digits. The

579

range is from 01 to 31 inclusive. Do \fBnot\fP

580

use a single decimal digit or the match will always fail!

581

.IP \fBd\fP 4

582

is the day of the week, expressed with one decimal digit. The

583

range is from 1 (Monday) to 7 (Sunday) inclusive.

584

.IP \fBHH\fP 4

585

is the hour of the day, written with two decimal digits, and given in

586

hours after midnight. The range is 00 (midnight to just before 1am)

587

to 23 (11pm to just before midnight) inclusive. Do \fBnot\fP use a

588

single decimal digit or the match will always fail!

589

.RE

590

.\" The following two lines are a workaround for a man2html bug. Please leave them.

591

.\" They define a non-existent option; useful because man2html can't correctly reset the margins.

592

.TP

593

.B \&

594

Some examples follow. In reading these, keep in mind that in extended

595

regular expressions a dot \fB\'.\'\fP matches any single character, and

596

a parenthetical expression such as \fB\'(A|B|C)\'\fP denotes any one of the three possibilities \fBA\fP,

597

\fBB\fP, or \fBC\fP.

598

599

To schedule a short Self-Test between 2-3am every morning, use:

600

.nf

601

\fB \-s S/../.././02\fP

602

.fi

603

To schedule a long Self-Test between 4-5am every Sunday morning, use:

604

.nf

605

\fB \-s L/../../7/04\fP

606

.fi

607

To schedule a long Self-Test between 10-11pm on the first and

608

fifteenth day of each month, use:

609

.nf

610

\fB \-s L/../(01|15)/./22\fP

611

.fi

612

To schedule an Offline Immediate test after every midnight, 6am,

613

noon,and 6pm, plus a Short Self-Test daily at 1-2am and a Long

614

Self-Test every Saturday at 3-4am, use:

615

.nf

616

\fB \-s (O/../.././(00|06|12|18)|S/../.././01|L/../../6/03)\fP

617

.fi

618

If Long Self-Tests of a large disks take longer than the system uptime,

619

a full disk test can be performed by several Selective Self-Tests.

620

To setup a full test of a 1TB disk within 20 days (one 50GB span

621

each day), run this command once:

622

.nf

623

smartctl -t select,0-99999999 /dev/sda

624

.fi

625

To run the next test spans on Monday-Friday between 12-13am, run smartd

626

with this directive:

627

.nf

628

\fB \-s n/../../[1-5]/12\fP

629

.fi

630

631

632

Scheduled tests are run immediately following the regularly-scheduled

633

device polling, if the current local date, time, and test type, match

634

\fBREGEXP\fP. By default the regularly-scheduled device polling

635

occurs every thirty minutes after starting \fBsmartd\fP. Take caution

636

if you use the \'\-i\' option to make this polling interval more than

637

sixty minutes: the poll times may fail to coincide with any of the

638

testing times that you have specified with \fBREGEXP\fP. In this case

639

the test will be run following the next device polling.

640

641

Before running an offline or self-test, \fBsmartd\fP checks to be sure

642

that a self-test is not already running. If a self-test \fBis\fP

643

already running, then this running self test will \fBnot\fP be

644

interrupted to begin another test.

645

646

\fBsmartd\fP will not attempt to run \fBany\fP type of test if another

647

test was already started or run in the same hour.

648

649

To avoid performance problems during system boot, \fBsmartd\fP will

650

not attempt to run any scheduled tests following the very first

651

device polling (unless \'\-q onecheck\' is specified).

652

653

Each time a test is run, \fBsmartd\fP will log an entry to SYSLOG.

654

You can use these or the '-q showtests' command-line option to verify

655

that you constructed \fBREGEXP\fP correctly. The matching order

656

(\fBL\fP before \fBS\fP before \fBC\fP before \fBO\fP) ensures that

657

if multiple test types are all scheduled for the same hour, the

658

longer test type has precedence. This is usually the desired behavior.

659

660

If the scheduled tests are used in conjunction with state persistence

661

(\'\-s\' option), smartd will also try to match the hours since last

662

shutdown (or 90 days at most). If any test would have been started

663

during downtime, the longest (see above) of these tests is run after

664

second device polling.

665

666

If the \'\-n\' directive is used and any test would have been started

667

during disk standby time, the longest of these tests is run when the

668

disk is active again.

669

670

Unix users: please beware that the rules for extended regular

671

expressions [regex(7)] are \fBnot\fP the same as the rules for

672

file\-name pattern matching by the shell [glob(7)]. \fBsmartd\fP will

673

issue harmless informational warning messages if it detects characters

674

in \fBREGEXP\fP that appear to indicate that you have made this

675

mistake.

676

677

.TP

678

.B \-m ADD

679

Send a warning email to the email address \fBADD\fP if the \'\-H\',

680

\'\-l\', \'\-f\', \'\-C\', or \'\-O\' Directives detect a failure or a

681

new error, or if a SMART command to the disk fails. This Directive

682

only works in conjunction with these other Directives (or with the

683

equivalent default \'\-a\' Directive).

684

685

To prevent your email in-box from getting filled up with warning

686

messages, by default only a single warning will be sent for each of

687

the enabled alert types, \'\-H\', \'\-l\', \'\-f\', \'\-C\', or

688

\'\-O\' even if more than one failure or error is detected or if the

689

failure or error persists. [This behavior can be modified; see the

690

\'\-M\' Directive below.]

691

692

To send email to more than one user, please use the following "comma

693

separated" form for the address: \fBuser1@add1,user2@add2,...,userN@addN\fP

694

(with no spaces).

695

696

To test that email is being sent correctly, use the \'\-M test\'

697

Directive described below to send one test email message on

698

\fBsmartd\fP

699

startup.

700

701

By default, email is sent using the system

702

.B mail

703

command. In order that

704

\fBsmartd\fP

705

find the mail command (normally /bin/mail) an executable named

706

.B \'mail\'

707

must be in the path of the shell or environment from which

708

\fBsmartd\fP

709

was started. If you wish to specify an explicit path to the mail

710

executable (for example /usr/local/bin/mail) or a custom script to

711

run, please use the \'\-M exec\' Directive below.

712

713

Note that by default under Solaris, in the previous paragraph,

714

\'\fBmailx\fP\' and \'\fB/bin/mailx\fP\' are used, since Solaris

715

\'/bin/mail\' does not accept a \'\-s\' (Subject) command-line

716

argument.

717

718

On Windows, the \'\fBBlat\fP\' mailer

719

(\fBhttp://blat.sourceforge.net/\fP) is used by default.

720

This mailer uses a different command line syntax, see

721

\'\-M exec\' below.

722

723

Note also that there is a special argument

724

.B <nomailer>

725

which can be given to the \'\-m\' Directive in conjunction with the \'\-M

726

exec\' Directive. Please see below for an explanation of its effect.

727

728

If the mailer or the shell running it produces any STDERR/STDOUT

729

output, then a snippet of that output will be copied to SYSLOG. The

730

remainder of the output is discarded. If problems are encountered in

731

sending mail, this should help you to understand and fix them. If

732

you have mail problems, we recommend running \fBsmartd\fP in debug

733

mode with the \'-d\' flag, using the \'-M test\' Directive described

734

below.

735

736

The following extension is available on Windows:

737

By specifying \'\fBmsgbox\fP\' as a mail address, a warning

738

"email" is displayed as a message box on the screen.

739

Using both \'\fBmsgbox\fP\' and regular mail addresses is possible,

740

if \'\fBmsgbox\fP\' is the first word in the comma separated list.

741

With \'\fBsysmsgbox\fP\', a system modal (always on top) message box

742

is used. If running as a service, a service notification message box

743

(always shown on current visible desktop) is used.

744

745

.TP

746

.B \-M TYPE

747

These Directives modify the behavior of the

748

\fBsmartd\fP

749

email warnings enabled with the \'\-m\' email Directive described above.

750

These \'\-M\' Directives only work in conjunction with the \'\-m\'

751

Directive and can not be used without it.

752

753

Multiple \-M Directives may be given. If more than one of the

754

following three \-M Directives are given (example: \-M once \-M daily)

755

then the final one (in the example, \-M daily) is used.

756

757

The valid arguments to the \-M Directive are (one of the following

758

three):

759

760

.I once

761

\- send only one warning email for each type of disk problem detected. This

762

is the default.

763

764

.I daily

765

\- send additional warning reminder emails, once per day, for each type

766

of disk problem detected.

767

768

.I diminishing

769

\- send additional warning reminder emails, after a one-day interval,

770

then a two-day interval, then a four-day interval, and so on for each

771

type of disk problem detected. Each interval is twice as long as the

772

previous interval.

773

774

In addition, one may add zero or more of the following Directives:

775

776

.I test

777

\- send a single test email

778

immediately upon

779

\fBsmartd\fP

780

startup. This allows one to verify that email is delivered correctly.

781

Note that if this Directive is used,

782

\fBsmartd\fP

783

will also send the normal email warnings that were enabled with the \'\-m\' Directive,

784

in addition to the single test email!

785

786

.I exec PATH

787

\- run the executable PATH instead of the default mail command, when

788

\fBsmartd\fP

789

needs to send email. PATH must point to an executable binary file or

790

script.

791

792

By setting PATH to point to a customized script, you can make

793

\fBsmartd\fP perform useful tricks when a disk problem is detected

794

(beeping the console, shutting down the machine, broadcasting warnings

795

to all logged-in users, etc.) But please be careful. \fBsmartd\fP

796

will \fBblock\fP until the executable PATH returns, so if your

797

executable hangs, then \fBsmartd\fP will also hang. Some sample

798

scripts are included in

799

/usr/local/share/doc/smartmontools-5.1/examplescripts/.

800

801

The return status of the executable is recorded by \fBsmartd\fP in

802

SYSLOG. The executable is not expected to write to STDOUT or

803

STDERR. If it does, then this is interpreted as indicating that

804

something is going wrong with your executable, and a fragment of this

805

output is logged to SYSLOG to help you to understand the problem.

806

Normally, if you wish to leave some record behind, the executable

807

should send mail or write to a file or device.

808

809

Before running the executable, \fBsmartd\fP sets a number of

810

environment variables. These environment variables may be used to

811

control the executable\'s behavior. The environment variables

812

exported by \fBsmartd\fP are:

813

.RS 7

814

.IP \fBSMARTD_MAILER\fP 4

815

is set to the argument of \-M exec, if present or else to \'mail\'

816

(examples: /bin/mail, mail).

817

.IP \fBSMARTD_DEVICE\fP 4

818

is set to the device path (examples: /dev/hda, /dev/sdb).

819

.IP \fBSMARTD_DEVICETYPE\fP 4

820

is set to the device type (possible values: ata, scsi, 3ware,N,

821

areca,N, hpt,L/M/N). Here N=0,...,127 denotes the ATA disk behind a

822

3ware RAID controller and L/M/N denotes the SATA disk behind a

823

HighPoint RocketRAID controller.

824

.IP \fBSMARTD_DEVICESTRING\fP 4

825

is set to the device description. For SMARTD_DEVICETYPE of ata or

826

scsi, this is the same as SMARTD_DEVICE. For 3ware RAID controllers,

827

the form used is \'/dev/sdc [3ware_disk_01]\'. For HighPoint

828

RocketRAID controller, the form is \'/dev/sdd [hpt_1/1/1]\' under Linux

829

or \'/dev/hptrr [hpt_1/1/1]\' under FreeBSD. For Areca controllers, the

830

form is \'/dev/sg2 [areca_disk_09]\'. In these cases the device string

831

contains a space and is NOT quoted. So to use $SMARTD_DEVICESTRING in a

832

bash script you should probably enclose it in double quotes.

833

.IP \fBSMARTD_FAILTYPE\fP 4

834

gives the reason for the warning or message email. The possible values that

835

it takes and their meanings are:

836

.nf

837

.fi

838

\fIEmailTest\fP: this is an email test message.

839

.nf

840

.fi

841

\fIHealth\fP: the SMART health status indicates imminent failure.

842

.nf

843

.fi

844

\fIUsage\fP: a usage Attribute has failed.

845

.nf

846

.fi

847

\fISelfTest\fP: the number of self-test failures has increased.

848

.nf

849

.fi

850

\fIErrorCount\fP: the number of errors in the ATA error log has increased.

851

.nf

852

.fi

853

\fICurrentPendingSector\fP: one of more disk sectors could not be

854

read and are marked to be reallocated (replaced with spare sectors).

855

.nf

856

.fi

857

\fIOfflineUncorrectableSector\fP: during off\-line testing, or self\-testing,

858

one or more disk sectors could not be read.

859

.nf

860

.fi

861

\fIFailedHealthCheck\fP: the SMART health status command failed.

862

.nf

863

.fi

864

\fIFailedReadSmartData\fP: the command to read SMART Attribute data failed.

865

.nf

866

.fi

867

\fIFailedReadSmartErrorLog\fP: the command to read the SMART error log failed.

868

.nf

869

.fi

870

\fIFailedReadSmartSelfTestLog\fP: the command to read the SMART self-test log failed.

871

.nf

872

.fi

873

\fIFailedOpenDevice\fP: the open() command to the device failed.

874

.IP \fBSMARTD_ADDRESS\fP 4

875

is determined by the address argument ADD of the \'\-m\' Directive.

876

If ADD is \fB<nomailer>\fP, then \fBSMARTD_ADDRESS\fP is not set.

877

Otherwise, it is set to the comma-separated-list of email addresses

878

given by the argument ADD, with the commas replaced by spaces

879

(example:admin@example.com root). If more than one email address is

880

given, then this string will contain space characters and is NOT

881

quoted, so to use it in a bash script you may want to enclose it in

882

double quotes.

883

.IP \fBSMARTD_MESSAGE\fP 4

884

is set to the one sentence summary warning email message string from

885

\fBsmartd\fP.

886

This message string contains space characters and is NOT quoted. So to

887

use $SMARTD_MESSAGE in a bash script you should probably enclose it in

888

double quotes.

889

.IP \fBSMARTD_FULLMESSAGE\fP 4

890

is set to the contents of the entire email warning message string from

891

\fBsmartd\fP.

892

This message string contains space and return characters and is NOT quoted. So to

893

use $SMARTD_FULLMESSAGE in a bash script you should probably enclose it in

894

double quotes.

895

.IP \fBSMARTD_TFIRST\fP 4

896

is a text string giving the time and date at which the first problem

897

of this type was reported. This text string contains space characters

898

and no newlines, and is NOT quoted. For example:

899

.nf

900

.fi

901

Sun Feb 9 14:58:19 2003 CST

902

.IP \fBSMARTD_TFIRSTEPOCH\fP 4

903

is an integer, which is the unix epoch (number of seconds since Jan 1,

904

1970) for \fBSMARTD_TFIRST\fP.

905

.RE

906

.\" The following two lines are a workaround for a man2html bug. Please leave them.

907

.\" They define a non-existent option; useful because man2html can't correctly reset the margins.

908

.TP

909

.B \&

910

The shell which is used to run PATH is system-dependent. For vanilla

911

Linux/glibc it\'s bash. For other systems, the man page for

912

\fBpopen\fP(3) should say what shell is used.

913

914

If the \'\-m ADD\' Directive is given with a normal address argument,

915

then the executable pointed to by PATH will be run in a shell with

916

STDIN receiving the body of the email message, and with the same

917

command-line arguments:

918

.nf

919

-s "$SMARTD_SUBJECT" $SMARTD_ADDRESS

920

.fi

921

that would normally be provided to \'mail\'. Examples include:

922

.nf

923

.B -m user@home -M exec /bin/mail

924

.B -m admin@work -M exec /usr/local/bin/mailto

925

.B -m root -M exec /Example_1/bash/script/below

926

.fi

927

928

Note that on Windows, the syntax of the \'\fBBlat\fP\' mailer is

929

used:

930

.nf

931

- -q -subject "$SMARTD_SUBJECT" -to "$SMARTD_ADDRESS"

932

.fi

933

934

If the \'\-m ADD\' Directive is given with the special address argument

935

.B <nomailer>

936

then the executable pointed to by PATH is run in a shell with

937

.B no

938

STDIN and

939

.B no

940

command-line arguments, for example:

941

.nf

942

.B -m <nomailer> -M exec /Example_2/bash/script/below

943

.fi

944

If the executable produces any STDERR/STDOUT output, then \fBsmartd\fP

945

assumes that something is going wrong, and a snippet of that output

946

will be copied to SYSLOG. The remainder of the output is then

947

discarded.

948

949

Some EXAMPLES of scripts that can be used with the \'\-M exec\'

950

Directive are given below. Some sample scripts are also included in

951

/usr/local/share/doc/smartmontools-5.1/examplescripts/.

952

953

.TP

954

.B \-f

955

Check for \'failure\' of any Usage Attributes. If these Attributes are

956

less than or equal to the threshold, it does NOT indicate imminent

957

disk failure. It "indicates an advisory condition where the usage or

958

age of the device has exceeded its intended design life period."

959

[Please see the \fBsmartctl \-A\fP command-line option.]

960

.TP

961

.B \-p

962

Report anytime that a Prefail Attribute has changed

963

its value since the last check, 30 minutes ago. [Please see the

964

.B smartctl \-A

965

command-line option.]

966

.TP

967

.B \-u

968

Report anytime that a Usage Attribute has changed its value

969

since the last check, 30 minutes ago. [Please see the

970

.B smartctl \-A

971

command-line option.]

972

.TP

973

.B \-t

974

Equivalent to turning on the two previous flags \'\-p\' and \'\-u\'.

975

Tracks changes in \fIall\fP device Attributes (both Prefailure and

976

Usage). [Please see the \fBsmartctl\fP \-A command-line option.]

977

.TP

978

.B \-i ID

979

Ignore device Attribute number \fBID\fP when checking for failure of

980

Usage Attributes. \fBID\fP must be a decimal integer in the range

981

from 1 to 255. This Directive modifies the behavior of the \'\-f\'

982

Directive and has no effect without it.

983

984

This is useful, for example, if you have a very old disk and don\'t

985

want to keep getting messages about the hours-on-lifetime Attribute

986

(usually Attribute 9) failing. This Directive may appear multiple

987

times for a single device, if you want to ignore multiple Attributes.

988

.TP

989

.B \-I ID

990

Ignore device Attribute \fBID\fP when tracking changes in the

991

Attribute values. \fBID\fP must be a decimal integer in the range

992

from 1 to 255. This Directive modifies the behavior of the \'\-p\',

993

\'\-u\', and \'\-t\' tracking Directives and has no effect without one

994

of them.

995

996

This is useful, for example, if one of the device Attributes is the disk

997

temperature (usually Attribute 194 or 231). It\'s annoying to get reports

998

each time the temperature changes. This Directive may appear multiple

999

times for a single device, if you want to ignore multiple Attributes.

1000

.TP

1001

.B \-r ID[!]

1002

When tracking, report the \fIRaw\fP value of Attribute \fBID\fP along

1003

with its (normally reported) \fINormalized\fP value. \fBID\fP must be

1004

a decimal integer in the range from 1 to 255. This Directive modifies

1005

the behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives

1006

and has no effect without one of them. This Directive may be given

1007

multiple times.

1008

1009

A common use of this Directive is to track the device Temperature

1010

(often ID=194 or 231).

1011

1012

If the optional flag \'!\' is appended, a change of the Normalized

1013

value is considered critical. The report will be logged as LOG_CRIT

1014

and a warning email will be sent if \'-m\' is specified.

1015

1016

.TP

1017

.B \-R ID[!]

1018

When tracking, report whenever the \fIRaw\fP value of Attribute

1019

\fBID\fP changes. (Normally \fBsmartd\fP only tracks/reports changes

1020

of the \fINormalized\fP Attribute values.) \fBID\fP must be a decimal

1021

integer in the range from 1 to 255. This Directive modifies the

1022

behavior of the \'\-p\', \'\-u\', and \'\-t\' tracking Directives and

1023

has no effect without one of them. This Directive may be given

1024

multiple times.

1025

1026

If this Directive is given, it automatically implies the \'\-r\'

1027

Directive for the same Attribute, so that the Raw value of the

1028

Attribute is reported.

1029

1030

A common use of this Directive is to track the device Temperature

1031

(often ID=194 or 231). It is also useful for understanding how

1032

different types of system behavior affects the values of certain

1033

Attributes.

1034

1035

If the optional flag \'!\' is appended, a change of the Raw

1036

value is considered critical. The report will be logged as

1037

LOG_CRIT and a warning email will be sent if \'-m\' is specified.

1038

An example is \'-R 5!\' to warn when new sectors are reallocated.

1039

1040

.TP

1041

.B \-C ID[+]

1042

[ATA only] Report if the current number of pending sectors is

1043

non-zero. Here \fBID\fP is the id number of the Attribute whose raw

1044

value is the Current Pending Sector count. The allowed range of

1045

\fBID\fP is 0 to 255 inclusive. To turn off this reporting, use

1046

ID\ =\ 0. If the \fB\-C ID\fP option is not given, then it defaults to

1047

\fB\-C 197\fP (since Attribute 197 is generally used to monitor

1048

pending sectors).

1049

1050

If \'+\' is specified, a report is only printed if the number of sectors

1051

has increased between two check cycles. Some disks do not reset this

1052

attribute when a bad sector is reallocated.

1053