/ 
Disk-SmartTools-v3.3.16
/ Disk::SmartTools

NAME

Disk::SmartTools - Provide tools to work with disks via S.M.A.R.T.

VERSION

Version v3.3.16

SYNOPSIS

Provides disk related functions.

use Disk::SmartTools;

my $cmd_path = get_smart_cmd();


...

EXPORT

get_disk_prefix
os_disks
get_smart_cmd
get_raid_cmd
get_raid_flag
get_diskutil_cmd
get_physical_disks
get_smart_disks
is_drive_smart
get_softraidtool_cmd

SUBROUTINES/METHODS

get_disk_prefix()

Returns the proper disk prefix depending on the OS: /dev/sd for linux, /dev/disk for macOS.

my $disk_prefix = get_disk_prefix();

os_disks()

Returns a list of possible disks based on OS, prefixed by get_disk_prefix().

Should parse diskutil on macs and lsblk on linux for more accuracy.

my @disks = os_disks();

get_smart_cmd()

Find the path to smartctl or quit.

my $smart_cmd = get_smart_cmd();

get_raid_cmd()

Find the path to lspci or return undef.

my $raid_cmd = get_raid_cmd();

get_raid_flag()

Find the raid flag for use with the current RAID. Currently supports Highpoint and MegaRAID controllers.

my $raid_flag = get_raid_flag();

get_softraidtool_cmd()

Find the path to softraidtool or return undef.

my $softraid_cmd = get_softraidtool_cmd();

get_diskutil_cmd()

On MacOS, find the path to diskutil or return undef.

my $diskutil_cmd = get_diskutil_cmd();

get_physical_disks()

On MacOS, find the physical disks (not synthesized or disk image)

my @disks = get_physical_disks();

get_smart_disks(@disks)

Given a list of disks, find all disks that support SMART and return as a list

my @smart_disks = get_smart_disks(@disks);

is_drive_smart($disk)

Test if a disk supports SMART

my $drive_is_smart = is_drive_smart($disk);

smart_on_for($disk)

Test is SMART is enabled for a disk

my $smart_enabled = smart_on_for($disk);

smart_test_for

Run smart test on a disk, specify test_type (short, long)

$smart_test_started = smart_test_for($disk);

selftest_history_for

Show the self-test history for a disk

selftest_history_for($disk);

smart_cmd_for

Run a smart command for a disk

my $return_buffer_ref
    = smart_cmd_for(
                     { cmd_path => $cmd_path,
                       cmd_type => $cmd_type,
                       disk     => $current_disk
                     }
                   );

load_local_config(HOSTNAME)

Load host local disk configuration from $HOME/.smarttools.yml if it exists. This allows for manual configuration in the case where the automatic detection of disks is not precise.

HOSTNAME host name specified in configuration file. Allows a single configuration file to be deployed with multiple host's configurations.

my $local_config_ref = load_local_config($hostname);

EXAMPLES

Two example programs demonstrate how the `Disk::SmartTools` modules can be used.

smart_show.pl

Display SMART information on disks.

$ smart_show.pl

Asks for the type of SMART information to display then reports for each physical disk in the system.

Display SMART information
--------------------------
Choose attribute to display:
     a. All SMART Info
     b. Info
     c. Overall-Health
     d. SelfTest History
     e. Error Log
     f. Temperature Graph
     g. Power_On_Hours
     h. Power_Cycle_Count
     i. Temperature_Celsius
     j. Reallocated_Sector_Ct
     k. Offline_Uncorrectable
     l. Raw_Read_Error_Rate
     m. Seek_Error_Rate
     n. Reported_Uncorrect
     o. Command_Timeout
     p. Current_Pending_Sector

Must be run as root.

smart_run_tests.pl

Runs a SMART test on all disks. Typically run as a crontab.

$ smart_run_tests.pl <args>

--test_type : Length of SMART test, short (default) or long
--dry_run : Don't actually perform SMART test
--debug : Turn debugging on
--verbose : Generate debugging info on stderr
--silent : Do not print report on stdout
--help : This helpful information.

Must be run as root.

Crontabs

Usually run as a crontab. Note the --long option is safe to run everyday, it will only run the long test on (up to) one disk a day. By hashing the day of the month with the disk index it will run once a month for each disk.

30 5 * * * : S.M.A.R.T. disk checks - short ; /var/root/bin/smart_run_tests.pl

4 6 * * * : S.M.A.R.T. disk checks - long ; /var/root/bin/smart_run_tests.pl --test_type=long

AUTHOR

Matt Martini, <matt at imaginarywave.com>

BUGS

Please report any bugs or feature requests to bug-disk-smarttools at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Disk-SmartTools. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Disk::SmartTools
perldoc smart_show.pl
perldoc smart_run_test.pl

You can also look for information at:

ACKNOWLEDGMENTS

LICENSE AND COPYRIGHT

This software is Copyright © 2024-2025 by Matt Martini.

This is free software, licensed under:

The GNU General Public License, Version 3, June 2007