Last active
December 6, 2023 00:39
-
-
Save mweisel/3c357eba86ac6cae15b2 to your computer and use it in GitHub Desktop.
PowerShell advanced function (script cmdlet) to query, retrieve, and display local drive/disk information. (https://binarynature.blogspot.com/2010/04/powershell-version-of-df-command.html)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
function Get-DiskFree | |
{ | |
[CmdletBinding()] | |
param | |
( | |
[Parameter(Position=0, | |
ValueFromPipeline=$true, | |
ValueFromPipelineByPropertyName=$true)] | |
[Alias('hostname')] | |
[Alias('cn')] | |
[string[]]$ComputerName = $env:COMPUTERNAME, | |
[Parameter(Position=1, | |
Mandatory=$false)] | |
[Alias('runas')] | |
[System.Management.Automation.Credential()]$Credential = | |
[System.Management.Automation.PSCredential]::Empty, | |
[Parameter(Position=2)] | |
[switch]$Format | |
) | |
BEGIN | |
{ | |
function Format-HumanReadable | |
{ | |
param ($size) | |
switch ($size) | |
{ | |
{$_ -ge 1PB}{"{0:#.#'P'}" -f ($size / 1PB); break} | |
{$_ -ge 1TB}{"{0:#.#'T'}" -f ($size / 1TB); break} | |
{$_ -ge 1GB}{"{0:#.#'G'}" -f ($size / 1GB); break} | |
{$_ -ge 1MB}{"{0:#.#'M'}" -f ($size / 1MB); break} | |
{$_ -ge 1KB}{"{0:#'K'}" -f ($size / 1KB); break} | |
default {"{0}" -f ($size) + "B"} | |
} | |
} | |
$wmiq = 'SELECT * FROM Win32_LogicalDisk WHERE Size != Null AND DriveType >= 2' | |
} | |
PROCESS | |
{ | |
foreach ($computer in $ComputerName) | |
{ | |
try | |
{ | |
if ($computer -eq $env:COMPUTERNAME) | |
{ | |
$disks = Get-WmiObject -Query $wmiq ` | |
-ComputerName $computer -ErrorAction Stop | |
} | |
else | |
{ | |
$disks = Get-WmiObject -Query $wmiq ` | |
-ComputerName $computer -Credential $Credential ` | |
-ErrorAction Stop | |
} | |
if ($Format) | |
{ | |
# Create array for $disk objects and then populate | |
$diskarray = @() | |
$disks | ForEach-Object { $diskarray += $_ } | |
$diskarray | Select-Object @{n='Name';e={$_.SystemName}}, | |
@{n='Vol';e={$_.DeviceID}}, | |
@{n='Size';e={Format-HumanReadable $_.Size}}, | |
@{n='Used';e={Format-HumanReadable ` | |
(($_.Size)-($_.FreeSpace))}}, | |
@{n='Avail';e={Format-HumanReadable $_.FreeSpace}}, | |
@{n='Use%';e={[int](((($_.Size)-($_.FreeSpace))` | |
/($_.Size) * 100))}}, | |
@{n='FS';e={$_.FileSystem}}, | |
@{n='Type';e={$_.Description}} | |
} | |
else | |
{ | |
foreach ($disk in $disks) | |
{ | |
$diskprops = @{'Volume'=$disk.DeviceID; | |
'Size'=$disk.Size; | |
'Used'=($disk.Size - $disk.FreeSpace); | |
'Available'=$disk.FreeSpace; | |
'FileSystem'=$disk.FileSystem; | |
'Type'=$disk.Description | |
'Computer'=$disk.SystemName;} | |
# Create custom PS object and apply type | |
$diskobj = New-Object -TypeName PSObject ` | |
-Property $diskprops | |
$diskobj.PSObject.TypeNames.Insert(0,'BinaryNature.DiskFree') | |
Write-Output $diskobj | |
} | |
} | |
} | |
catch | |
{ | |
# Check for common DCOM errors and display "friendly" output | |
switch ($_) | |
{ | |
{ $_.Exception.ErrorCode -eq 0x800706ba } ` | |
{ $err = 'Unavailable (Host Offline or Firewall)'; | |
break; } | |
{ $_.CategoryInfo.Reason -eq 'UnauthorizedAccessException' } ` | |
{ $err = 'Access denied (Check User Permissions)'; | |
break; } | |
default { $err = $_.Exception.Message } | |
} | |
Write-Warning "$computer - $err" | |
} | |
} | |
} | |
END {} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is unimaginably small