RunningLow – PowerShell script to check for disk space and send e-mail
Today I would like to share with our readers RunningLow, a simple yet effective PowerShell script I coded a while ago to get to know when one of my servers is running low on disk space.
Whoever works with physical and/or virtualized Windows Servers is well aware of the importance of keeping this constantly under control: as soon as a server runs out of disk space it will be unable to fulfill a number of tasks, such as: creating temporary files, store data on a database, performing system maintenance/backup/updates, create or update web sessions – assuming they are handled through I/O – and so on. Things can be even worse for those servers that host DBMS services such as MySQL and MS-SQL, as the sudden I/O unavailability could cause non-trivial damages to indexes, filesystem-based tables, and data integrity.
The main purpose of RunningLow is to prevent all that: it will check one or more local and/or network drives to see if their available free space went under a certain quota, and send a customizable alert to one or more e-mail addresses if that’s the case. I know, there are A LOT of admin suites and maintenance software that could be easily configured to do the same thing: even Piriform’s CCleaner PRO does that! However, if you don’t have the money, the time, or the amount of system resources required to install these apps, you might find out that this lightweight alternative could be worth a shot.
Source Code
Anyway, here’s the script source code:
|
|
# Drives to check: set to $null or empty to check all local (non-network) drives
# $drives = @(“C”,”D”); # The minimum disk size to check for raising the warning # SMTP configuration: username, password & so on
if ($drives -eq $null -Or $drives -lt 1) { $smtp = new-object Net.Mail.SmtpClient($email_smtp_host, $email_smtp_port); |
Copy/paste it into a text file, save it to RunningLow.ps1 (or any other name) and you should be set.
Here’s a list of all RunningLow configuration settings (and their meaning). Each one of them corresponds to a command-line parameter, meaning that you can either set them using the CLI or change their default value within the script itself.
- minSize
The minimum free disk space acceptable threshold: any checked drive with less available space will raise a warning.
- hosts
If specified, will also check the disk space on the given colon-separated list of hostnames (machine names OR ip addresses) within the LAN.
Example: $hosts = “HOSTNAME1:HOSTNAME2:129.168.0.115”
IMPORTANT: Connecting to remote machines will require launching RunningLow with elevated priviledges and having the Windows Management Service up, running and reachable (TCP port 5985) on the remote machine.
- volumes
A colon-separated list of the drive volumes (letters) to check: set it to $null to check all local (non-network) drives.
Example: $volumes = “C:D”;
- email_to
If specified, will send a low-disk-space warning email to the given colon-separated addresses.
Example: $email_to = “[email protected]:[email protected]“;
Default is $null (no e-mail will be sent). Replace it with [email protected] if you don’t want to set it from the CLI.
- email_username = "[email protected]"
- email_password = "yourpassword.mailserver"
- email_smtp_host = "smtp.yourdomain.com"
- email_smtp_port = 587
- email_smtp_SSL = $true
- email_from = "[email protected]"
The above parameters can be used to set up your SMTP configuration for sending the e-mail alerts: username, password & so on. It’s strongly advisable to set them within the code instead of setting them from the CLI, as you might rarely want to change them. Needless to say, if you don’t want RunningLow to send any e-mail, you might as well skip the whole part: just remember to set -email_to value to $null to have the code skip that as well.
Configuration
The first ten or so lines host the configuration settings, which you should change accordingly to your needs and depending to your specific scenario. The most important thing to understand is the first line: as we can see, we can either specify an array of drives – including network drives, as long as they’re permanently mapped to a local drive letter – or set a null value: if we go for the latter, the script will check all local drives.
The comments should be enough to guide you through this required part: however, if you need further assistance, you can use the comment section of this post to submit your query and I’ll do my best to help you with that.
Testing
As soon as you’re done with the configuration, you can test the script from the standard Windows Command Prompt with the following command:
powershell -executionpolicy bypass -File C:\script\RunningLow.ps1
As soon as you should see something like this: (… Meaning that everything went ok.)
Sending E-Mail Alerts
Needless to say, you should then edit the script, raise the $minSize value to a ridiculously high amount (such as 5TB) and run another test to ensure that the e-mail alerts will actually be sent:
… That’s it.
Installing
It goes without saying that the script should not be launched manually: the best thing we can do to ensure that it will be executed on regular basis is to create an appropriate entry in the Windows Task Scheduler. In the example below, RunningLow will be executed once a day at noon:
In the New Action window you can either insert the full execution statement (including parameters) in the Program/script textbox, or use the Add arguments (optional) textbox: the script will work either way. Similarly, you can specify the full path of the RunningLow.ps1 file within the -File parameter or put it into the Start in (optional) textbox, just like we did in the above screenshot.
IMPORTANT: In the scheduled task General tab, be sure to activate the options Run whether the user is logged on or not and Run with highest priviledges, otherwise the script would run only if there’s a logged-in user during the execution time.
Be sure to test it again – by setting an insanely high $minSize – on the server as well, to be sure that there are no firewalls or other restrictions that would block the e-mail alerts.
Well, that’s it for now: I sincerely hope that you will enjoy having RunningLow on your servers just like I do!
