PSFolderSize.psm1
|
function Get-FolderSize { <# .SYNOPSIS Get-FolderSize Returns the size of folders in MB and GB. You can change the base path, omit folders, as well as output results in various formats. .DESCRIPTION This function will get the folder size in MB and GB of folders found in the basePath parameter. The basePath parameter defaults to C:\Users. You can also specify a specific folder name via the folderName parameter. VERSION HISTORY: 1.0 - Updated object creation, removed try/catch that was causing issues 0.5 - Just created! .PARAMETER BasePath This parameter allows you to specify the base path you'd like to get the child folders of. It defaults to where the module was run from via (Get-Location). .PARAMETER FolderName This parameter allows you to specify the name of a specific folder you'd like to get the size of. .PARAMETER AddTotal This parameter adds a total count at the end of the array .PARAMETER OmitFolders This parameter allows you to omit folder(s) (array of string) from being included .PARAMETER Output Use this option to output the results. Valid options are csv, xml, or json. .PARAMETER OutputPath Specify the path you want to use when outputting the results as a csv, xml, or json file. Do not include a trailing slash. Example: C:\users\you\Desktop Defaults to (Get-Location) This will be where you called the module from. .PARAMETER OutputFile This allows you to specify the path and file name you'd like for output. Example: C:\users\you\desktop\output.csv .EXAMPLE Get-FolderSize | Format-Table -AutoSize ------------------------------------- FolderName Size(Bytes) Size(MB) Size(GB) ---------- ----------- -------- -------- $GetCurrent 193768 0.18 MB 0.00 GB $RECYCLE.BIN 20649823 19.69 MB 0.02 GB $SysReset 53267392 50.80 MB 0.05 GB Config.Msi 0.00 MB 0.00 GB Documents and Settings 0.00 MB 0.00 GB Games 48522184491 46,274.36 MB 45.19 GB .EXAMPLE Get-FolderSize -BasePath 'C:\Program Files' ------------------------------------- FolderName Size(Bytes) Size(MB) Size(GB) ---------- ----------- -------- -------- 7-Zip 4588532 4.38 MB 0.00 GB Adobe 3567833029 3,402.55 MB 3.32 GB Application Verifier 353569 0.34 MB 0.00 GB Bonjour 615066 0.59 MB 0.00 GB Common Files 489183608 466.52 MB 0.46 GB .EXAMPLE Get-FolderSize -BasePath 'C:\Program Files' -FolderName IIS ------------------------------------- FolderName Size(Bytes) Size(MB) Size(GB) ---------- ----------- -------- -------- IIS 5480411 5.23 MB 0.01 GB .EXAMPLE $getFolderSize = Get-FolderSize $getFolderSize | Format-Table -AutoSize ------------------------------------- FolderName Size(GB) Size(MB) ---------- -------- -------- Public 0.00 GB 0.00 MB thegn 2.39 GB 2,442.99 MB .EXAMPLE $getFolderSize = Get-FolderSize -Output csv -OutputPath ~\Desktop $getFolderSize ------------------------------------- FolderName Size(GB) Size(MB) ---------- -------- -------- Public 0.00 GB 0.00 MB thegn 2.39 GB 2,442.99 MB (Results will also be exported as a CSV to your Desktop folder) .EXAMPLE Sort by size descending $getFolderSize = Get-FolderSize | Sort-Object 'Size(Bytes)' -Descending $getFolderSize ------------------------------------- FolderName Size(Bytes) Size(MB) Size(GB) ---------- ----------- -------- -------- Users 76280394429 72,746.65 MB 71.04 GB Games 48522184491 46,274.36 MB 45.19 GB Program Files (x86) 27752593691 26,466.94 MB 25.85 GB Windows 25351747445 24,177.31 MB 23.61 GB .EXAMPLE Omit folder(s) from being included Get-FolderSize.ps1 -OmitFolders 'C:\Temp','C:\Windows' #> [cmdletbinding( DefaultParameterSetName = 'default' )] param( [Parameter( Mandatory = $false, Position = 0, ParameterSetName = 'default' )] [Alias('Path')] [String[]] $BasePath = (Get-Location), [Parameter( Mandatory = $false, ParameterSetName = 'default' )] [Alias('User')] [String[]] $FolderName = 'all', [Parameter( ParameterSetName = 'default' )] [String[]] $OmitFolders, [Parameter( ParameterSetName = 'default' )] [Switch] $AddTotal, [Parameter( ParameterSetName = 'default' )] [Parameter( ParameterSetName = 'outputWithType' )] [ValidateSet('csv','xml','json')] [String] $Output, [Parameter( ParameterSetName = 'default' )] [Parameter( ParameterSetName = 'outputWithType' )] [String] $OutputPath = (Get-Location), [Parameter( ParameterSetName = 'default' )] [String] $OutputFile = [string]::Empty ) #Get a list of all the directories in the base path we're looking for. if ($folderName -eq 'all') { $allFolders = Get-ChildItem $BasePath -Directory -Force | Where-Object {$_.FullName -notin $OmitFolders} } else { $allFolders = Get-ChildItem $basePath -Directory -Force | Where-Object {($_.BaseName -like $FolderName) -and ($_.FullName -notin $OmitFolders)} } #Create array to store folder objects found with size info. [System.Collections.ArrayList]$folderList = @() #Go through each folder in the base path. ForEach ($folder in $allFolders) { #Clear out the variables used in the loop. $fullPath = $null $folderObject = $null $folderSize = $null $folderSizeInMB = $null $folderSizeInGB = $null $folderBaseName = $null #Store the full path to the folder and its name in separate variables $fullPath = $folder.FullName $folderBaseName = $folder.BaseName Write-Verbose "Working with [$fullPath]..." #Get folder info / sizes $folderSize = Get-Childitem -Path $fullPath -Recurse -Force -ErrorAction SilentlyContinue | Measure-Object -Property Length -Sum -ErrorAction SilentlyContinue #We use the string format operator here to show only 2 decimals, and do some PS Math. $folderSizeInMB = "{0:N2} MB" -f ($folderSize.Sum / 1MB) $folderSizeInGB = "{0:N2} GB" -f ($folderSize.Sum / 1GB) #Here we create a custom object that we'll add to the array $folderObject = [PSCustomObject]@{ FolderName = $folderBaseName 'Size(Bytes)' = $folderSize.Sum 'Size(MB)' = $folderSizeInMB 'Size(GB)' = $folderSizeInGB FullPath = $fullPath } #Add the object to the array $folderList.Add($folderObject) | Out-Null } if ($AddTotal) { $grandTotal = $null if ($folderList.Count -gt 1) { $folderList | ForEach-Object { $grandTotal += $_.'Size(Bytes)' } $totalFolderSizeInMB = "{0:N2} MB" -f ($grandTotal / 1MB) $totalFolderSizeInGB = "{0:N2} GB" -f ($grandTotal / 1GB) $folderObject = [PSCustomObject]@{ FolderName = 'GrandTotal' 'Size(Bytes)' = $grandTotal 'Size(MB)' = $totalFolderSizeInMB 'Size(GB)' = $totalFolderSizeInGB FullPath = 'N/A' } #Add the object to the array $folderList.Add($folderObject) | Out-Null } } if ($Output -or $OutputFile) { if (!$OutputFile) { $fileName = "{2}\{0:MMddyy_HHmm}.{1}" -f (Get-Date), $Output, $OutputPath } else { $fileName = $OutputFile $Output = $fileName.Substring($fileName.LastIndexOf('.') + 1) } Write-Verbose "Attempting to export results to -> [$fileName]!" try { switch ($Output) { 'csv' { $folderList | Sort-Object 'Size(Bytes)' -Descending | Export-Csv -Path $fileName -NoTypeInformation -Force } 'xml' { $folderList | Sort-Object 'Size(Bytes)' -Descending | Export-Clixml -Path $fileName } 'json' { $folderList | Sort-Object 'Size(Bytes)' -Descending | ConvertTo-Json | Out-File -FilePath $fileName -Force } } } catch { $errorMessage = $_.Exception.Message Write-Error "Error exporting file to [$fileName] -> [$errorMessage]!" } } #Return the object array with the objects selected in the order specified. Return $folderList | Sort-Object 'Size(Bytes)' -Descending } |