PowerShell/Docs/check-drives.md

103 lines
2.8 KiB
Markdown
Raw Normal View History

2023-07-29 09:55:25 +02:00
## Script: *check-drives.ps1*
2021-12-09 16:19:09 +01:00
2022-11-17 19:46:02 +01:00
This PowerShell script checks all drives for free space left.
2021-12-09 16:19:09 +01:00
## Parameters
```powershell
2023-07-29 09:45:37 +02:00
check-drives.ps1 [[-MinLevel] <Int32>] [<CommonParameters>]
2021-12-09 16:19:09 +01:00
-MinLevel <Int32>
2022-11-17 19:46:02 +01:00
Specifies the minimum warning level (10 GB by default)
2021-12-09 16:19:09 +01:00
Required? false
Position? 1
2022-11-17 19:46:02 +01:00
Default value 10
2021-12-09 16:19:09 +01:00
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS> ./check-drives
2023-05-26 12:20:18 +02:00
✅ C drive uses 87GB of 249GB
2021-12-09 16:19:09 +01:00
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-12-09 16:19:09 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2023-07-29 09:55:25 +02:00
## Script Content
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Checks the drive space
.DESCRIPTION
This PowerShell script checks all drives for free space left.
.PARAMETER MinLevel
Specifies the minimum warning level (10 GB by default)
.EXAMPLE
PS> ./check-drives
2023-05-26 12:20:18 +02:00
✅ C drive uses 87GB of 249GB
2022-11-17 20:02:26 +01:00
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([int]$MinLevel = 10) # 10 GB minimum
function Bytes2String { param([int64]$Bytes)
if ($Bytes -lt 1000) { return "$Bytes bytes" }
$Bytes /= 1000
if ($Bytes -lt 1000) { return "$($Bytes)KB" }
$Bytes /= 1000
if ($Bytes -lt 1000) { return "$($Bytes)MB" }
$Bytes /= 1000
if ($Bytes -lt 1000) { return "$($Bytes)GB" }
$Bytes /= 1000
if ($Bytes -lt 1000) { return "$($Bytes)TB" }
$Bytes /= 1000
if ($Bytes -lt 1000) { return "$($Bytes)PB" }
$Bytes /= 1000
if ($Bytes -lt 1000) { return "$($Bytes)EB" }
}
try {
2023-05-26 12:20:18 +02:00
Write-Progress "⏳ Querying drives..."
$Drives = Get-PSDrive -PSProvider FileSystem
Write-Progress -completed "done."
2022-11-17 20:02:26 +01:00
foreach($Drive in $Drives) {
$ID = $Drive.Name
$Details = (Get-PSDrive $ID)
[int64]$Free = $Details.Free
[int64]$Used = $Details.Used
[int64]$Total = ($Used + $Free)
if ($Total -eq 0) {
2023-05-26 12:20:18 +02:00
Write-Host "✅ $ID drive is empty"
} elseif ($Free -eq 0) {
Write-Host "⚠️ $ID drive with $(Bytes2String $Total) is full!"
2022-11-17 20:02:26 +01:00
} elseif ($Free -lt $MinLevel) {
2023-05-26 12:20:18 +02:00
Write-Host "⚠️ $ID drive with $(Bytes2String $Total) is nearly full ($(Bytes2String $Free) free)!"
2022-11-17 20:02:26 +01:00
} elseif ($Used -lt $Free) {
2023-05-26 12:20:18 +02:00
Write-Host "✅ $ID drive uses $(Bytes2String $Used) of $(Bytes2String $Total)"
2022-11-17 20:02:26 +01:00
} else {
2023-05-26 12:20:18 +02:00
Write-Host "✅ $ID drive has $(Bytes2String $Free) of $(Bytes2String $Total) free"
2022-11-17 20:02:26 +01:00
}
}
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2023-07-29 09:55:25 +02:00
*(generated by convert-ps2md.ps1 using the comment-based help of check-drives.ps1 as of 07/29/2023 09:55:09)*