Forge Home

smartd

Rule-based smartd service configuration management

1,235 downloads

186 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.5.0 (latest)
  • 0.4.0
  • 0.3.0
  • 0.2.0
  • 0.1.0
released Dec 10th 2023
This version is compatible with:
  • Puppet Enterprise 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.21.0 < 9.0.0
  • , , , , , , FreeBSD, Fedora, SLES

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'deric-smartd', '0.5.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add deric-smartd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install deric-smartd --version 0.5.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

deric/smartd — version 0.5.0 Dec 10th 2023

puppet-smartd

Puppet
Forge Build Status

Simplified smartd configuration management with Puppet.

Usage

include smartd

and confgure e-mail nofifications for all disks:

smartd::defaults: '-a -m root@domain.org'

this would generate a smartd.conf based on smartd::disks (by default $facts['disks'] is used):

DEFAULT -a -m root@domain.org
/dev/sda -d ata
/dev/sdb -d ata

Main class smartd supports following attributes:

  • defaults Shared configuration directives can be specified e.g. common email -m root@my.org. Accepts string or an array or strings.
  • disks Fact or Hash containing devices declaration
  • rules Applied smartd options to disks definition.
  • devicescan When enabled will automatically detect all matching devices (restricted by options). Default: false
  • options DEVICESCAN options, e.g. -d removable will ignore errors on removable devices. Requires devicescan: true. Accepts string or an array or strings.

By default Puppet built-in $facts['disks'] is used (accessible also via facter -y disks), e.g.:

nvme0n1:
  model: "SAMSUNG MZQL2960HCJR-00A07"
  serial: "S64FNE0R503522"
  size: 894.25 GiB
  size_bytes: 960197124096
  type: ssd

that can be used to generate configuration (at least simple list of devices). Though any other fact or hardcoded hash of disks might be used.

The rules parameter can be used to define e.g. model/vendor specific rules that might be generalized.

smartd::rules:
  - attr: model         # attr value match disk attributes, e.g. vendor, type, etc. might be used
    match: SAMSUNG MZ7
    options: -I 173     # ignore wear_level_count for disks matching this model

Match device name using special key $name:

smartd::rules:
  - attr: $name
    match: ^nvme  # regexp match
    options: -H   # will append all matching rules
  - attr: type
    match: ssd
    options:  -l error

this would output (assuming NVMe has attribute type with value ssd)

/dev/nvme0n1 -H -l error

Ignore device completely (will be ommited from the list):

smartd::rules:
  - attr: vendor
    match: DELL
    action: ignore

Apply megaraid device type

smartd::rules:
  - atrr: model
    match: PERC
    options: -d megaraid,0

Configuration parameters

See man smartd.conf for full configuration specification.

  • -a equivalent of -H -f -t -l error -l selftest -l selfteststs -C 197 -U 198
  • -m email address for notifications
  • -d device type auto,ata, scsi,nvme,ignore,removable
  • -H perform S.M.A.R.T health check, i.e. smartctl -H /dev/sda
  • -i ignore failure of Usage Attributes (e.g. percent of lifetime used)

Examples

Will scan for all devices, and then monitor them. It will send one email warning per device for any problems that are found.

smartd::devicescan: true
smartd::options: '-H -d ata -m root@example.com'

this would produce config:

DEVICESCAN -H -d ata -m root@example.com

that will ensure that smartd will check SMART health status on all ata drives daily.

Common configuration will be applied for all disks defined bellow (in the config).

smartd::defaults:
  - '-a -R5! -W 2,40,45 -I 194 -s L/../../7/00'
  - '-m admin@example.com'

Limitations

Written for Puppet 6 and newer, backward compatibility with older versions hasn't been tested.