1
0
mirror of https://github.com/Spearfoot/FreeNAS-scripts synced 2025-12-06 01:23:19 +00:00
2017-03-16 00:20:50 -05:00
2017-03-16 00:20:50 -05:00
2017-03-15 22:40:22 -05:00
2017-03-15 23:14:34 -05:00
2017-03-15 16:30:56 -05:00
2017-03-15 16:31:45 -05:00

FreeNAS Scripts

Bash scripts for use on FreeNAS servers

smart_report.sh and zpool_report.sh are my versions of these useful scripts available at the "Scripts to report SMART, ZPool and UPS status, HDD/CPU T°, HDD identification and backup the config" thread on the FreeNAS forum. The original author is FreeNAS forum member BiduleOhm, with others contributing suggestions and code changes. I have modified the syntax and made minor changes in formatting and spacing of the generated reports.

The other scripts are my own work unless otherwise noted.

I used the excellent shell script static analysis tool at https://www.shellcheck.net to insure that all of this code is free of issues. But this doesn't mean you won't find any errors. ☺️

smart_report.sh

Generates and emails you a status report with detailed SMART information about your system's drives.

By default, my version of this script uses a function I wrote which uses smartctl's scan list to obtain the SMART-enabled drives on the system, but you have the option of using either a hard-coded list or a sysctl-based method instead, if you so choose. This version allows for serial numbers up to 18 characters in length, where the original only supported 15. It also selects the "Device Model" as the drive 'brand' if the "Model Family" SMART attribute is unavailable.

You will need to edit the script and enter your email address before using it.

zpool_report.sh

Generates and emails you a status report about your system's pools.

You will need to edit the script and enter your email address before using it.

save_config.sh

Copies the FreeNAS system configuration file to a dataset you specify. The backup filenames are formed from the hostname, complete FreeNAS version, and date, in this format: hostname-freenas_version-date.db. Here is an example from a recent backup on my server named boomer:

boomer-FreeNAS-9.10.2-U2-e1497f2-20170315224905.db

Edit this script and specify the target dataset where you want the backup files copied.

set_hdd_erc.sh

Sets the Error Recovery Control (aka SCTERC or TLER) read and write values on your system's hard drives. What is this? There is a good discussion in the "Checking for TLER, ERC, etc. support on a drive" thread on the FreeNAS forum, and you can find more gory details in this FAQ at the smartmontools.org website. This key quote from the FAQ sums up why you want to set this up on your FreeNAS servers:

"It is best for ERC to be "enabled" when in a RAID array to prevent the recovery time from a disk read or write error from exceeding the RAID implementation's timeout threshold. If a drive times out, the hard disk will need to be manually re-added to the array, requiring a re-build and re-synchronization of the hard disk. Limiting the drives recovery timeout helps for improved error handling in the hardware or software RAID environments."

By default, the script sets both the read and write timeout value to 7 seconds. You can change either or both of these values to better suit your environment.

Some hard drives retain these values when powered down, but some do not - including the HGST 7K4000 drives I use in one of my systems. For this reason, I configure my FreeNAS servers to run set_hdd_src.sh as a post-init startup script.

Description
No description provided
Readme 245 KiB
Languages
Shell 82.4%
Perl 17.6%